doc/xml/gnome-vfs-directory-basic-ops.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-directory-basic-ops">
   2 <refmeta>
   3 <refentrytitle>Basic Directory Operations</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>Basic Directory Operations</refname><refpurpose>
  10 Creating and removing directories.</refpurpose>
  11 </refnamediv>
  12
  13 <refsynopsisdiv><title>Synopsis</title>
  14
  15 <synopsis>
  16
  17
  18
  19 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-make-directory">gnome_vfs_make_directory</link>     (const <link linkend="gchar">gchar</link> *text_uri,
  20                                              <link linkend="guint">guint</link> perm);
  21 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-make-directory-for-uri">gnome_vfs_make_directory_for_uri</link>
  22                                             (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
  23                                              <link linkend="guint">guint</link> perm);
  24 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-remove-directory">gnome_vfs_remove_directory</link>   (const <link linkend="gchar">gchar</link> *text_uri);
  25 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-remove-directory-from-uri">gnome_vfs_remove_directory_from_uri</link>
  26                                             (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);
  27 </synopsis>
  28 </refsynopsisdiv>
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38 <refsect1>
  39 <title>Description</title>
  40 <para>
  41
  42 </para>
  43 </refsect1>
  44
  45 <refsect1>
  46 <title>Details</title>
  47 <refsect2>
  48 <title><anchor id="gnome-vfs-make-directory"/>gnome_vfs_make_directory ()</title>
  49 <indexterm><primary>gnome_vfs_make_directory</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_make_directory     (const <link linkend="gchar">gchar</link> *text_uri,
  50                                              <link linkend="guint">guint</link> perm);</programlisting>
  51 <para>
  52 Create <parameter>text_uri</parameter> as a directory.</para>
  53 <para>
  54
  55 </para><variablelist role="params">
  56 <varlistentry><term><parameter>text_uri</parameter>&nbsp;:</term>
  57 <listitem><simpara> URI of the directory to be created
  58 </simpara></listitem></varlistentry>
  59 <varlistentry><term><parameter>perm</parameter>&nbsp;:</term>
  60 <listitem><simpara> Unix-style permissions for the newly created directory
  61 </simpara></listitem></varlistentry>
  62 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An integer representing the result of the operation
  63 </simpara></listitem></varlistentry>
  64 </variablelist></refsect2>
  65 <refsect2>
  66 <title><anchor id="gnome-vfs-make-directory-for-uri"/>gnome_vfs_make_directory_for_uri ()</title>
  67 <indexterm><primary>gnome_vfs_make_directory_for_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_make_directory_for_uri
  68                                             (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
  69                                              <link linkend="guint">guint</link> perm);</programlisting>
  70 <para>
  71 Create a directory at <parameter>uri</parameter>. Only succeeds if a file or directory
  72 does not already exist at <parameter>uri</parameter>.</para>
  73 <para>
  74
  75 </para><variablelist role="params">
  76 <varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
  77 <listitem><simpara> URI of the directory to be created
  78 </simpara></listitem></varlistentry>
  79 <varlistentry><term><parameter>perm</parameter>&nbsp;:</term>
  80 <listitem><simpara> Unix-style permissions for the newly created directory
  81 </simpara></listitem></varlistentry>
  82 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An integer representing the result of the operation
  83 </simpara></listitem></varlistentry>
  84 </variablelist></refsect2>
  85 <refsect2>
  86 <title><anchor id="gnome-vfs-remove-directory"/>gnome_vfs_remove_directory ()</title>
  87 <indexterm><primary>gnome_vfs_remove_directory</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_remove_directory   (const <link linkend="gchar">gchar</link> *text_uri);</programlisting>
  88 <para>
  89 Remove <parameter>text_uri</parameter>.  <parameter>text_uri</parameter> must be an empty directory.</para>
  90 <para>
  91
  92 </para><variablelist role="params">
  93 <varlistentry><term><parameter>text_uri</parameter>&nbsp;:</term>
  94 <listitem><simpara> URI of the directory to be removed
  95 </simpara></listitem></varlistentry>
  96 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An integer representing the result of the operation
  97 </simpara></listitem></varlistentry>
  98 </variablelist></refsect2>
  99 <refsect2>
 100 <title><anchor id="gnome-vfs-remove-directory-from-uri"/>gnome_vfs_remove_directory_from_uri ()</title>
 101 <indexterm><primary>gnome_vfs_remove_directory_from_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_remove_directory_from_uri
 102                                             (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 103 <para>
 104 Remove <parameter>uri</parameter>.  <parameter>uri</parameter> must be an empty directory.</para>
 105 <para>
 106
 107 </para><variablelist role="params">
 108 <varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 109 <listitem><simpara> URI of the directory to be removed
 110 </simpara></listitem></varlistentry>
 111 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An integer representing the result of the operation
 112 </simpara></listitem></varlistentry>
 113 </variablelist></refsect2>
 114
 115 </refsect1>
 116
 117
 118
 119
 120 </refentry>