doc/xml/gnome-vfs-file-advanced-ops.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-file-advanced-ops">
   2 <refmeta>
   3 <refentrytitle>Advanced File Operations</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>Advanced File Operations</refname><refpurpose></refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  18 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-file-control">gnome_vfs_file_control</link>       (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> *handle,
  19                                              const <link linkend="char">char</link> *operation,
  20                                              <link linkend="gpointer">gpointer</link> operation_data);
  21 </synopsis>
  22 </refsynopsisdiv>
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32 <refsect1>
  33 <title>Description</title>
  34 <para>
  35
  36 </para>
  37 </refsect1>
  38
  39 <refsect1>
  40 <title>Details</title>
  41 <refsect2>
  42 <title><anchor id="gnome-vfs-file-control"/>gnome_vfs_file_control ()</title>
  43 <indexterm><primary>gnome_vfs_file_control</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_file_control       (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> *handle,
  44                                              const <link linkend="char">char</link> *operation,
  45                                              <link linkend="gpointer">gpointer</link> operation_data);</programlisting>
  46 <para>
  47 Execute a backend dependent operation specified by the string <parameter>operation</parameter>.
  48 This is typically used for specialized vfs backends that need additional
  49 operations that gnome-vfs doesn't have. Compare it to the unix call <link linkend="ioctl"><function>ioctl()</function></link>.
  50 The format of <parameter>operation_data</parameter> depends on the operation. Operation that are
  51 backend specific are normally namespaced by their module name.</para>
  52 <para>
  53
  54 </para><variablelist role="params">
  55 <varlistentry><term><parameter>handle</parameter>&nbsp;:</term>
  56 <listitem><simpara> handle of the file to affect
  57 </simpara></listitem></varlistentry>
  58 <varlistentry><term><parameter>operation</parameter>&nbsp;:</term>
  59 <listitem><simpara> The operation to execute
  60 </simpara></listitem></varlistentry>
  61 <varlistentry><term><parameter>operation_data</parameter>&nbsp;:</term>
  62 <listitem><simpara> The data needed to execute the operation
  63 </simpara></listitem></varlistentry>
  64 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an integer representing the success of the operation
  65 </simpara></listitem></varlistentry>
  66 </variablelist></refsect2>
  67
  68 </refsect1>
  69
  70
  71
  72
  73 </refentry>