doc/xml/gnome-vfs-method.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-method">
   2 <refmeta>
   3 <refentrytitle>gnome-vfs-method</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>gnome-vfs-method</refname><refpurpose></refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  18 <link linkend="GnomeVFSMethod">GnomeVFSMethod</link>* (<link linkend="GnomeVFSMethodInitFunc">*GnomeVFSMethodInitFunc</link>)   (const <link linkend="char">char</link> *method_name,
  19                                              const <link linkend="char">char</link> *config_args);
  20 <link linkend="void">void</link>        (<link linkend="GnomeVFSMethodShutdownFunc">*GnomeVFSMethodShutdownFunc</link>)   (<link linkend="GnomeVFSMethod">GnomeVFSMethod</link> *method);
  21 <link linkend="GnomeVFSResult">GnomeVFSResult</link> (<link linkend="GnomeVFSMethodTruncateFunc">*GnomeVFSMethodTruncateFunc</link>)
  22                                             (<link linkend="GnomeVFSMethod">GnomeVFSMethod</link> *method,
  23                                              <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
  24                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length,
  25                                              <link linkend="GnomeVFSContext">GnomeVFSContext</link> *context);
  26 <link linkend="GnomeVFSResult">GnomeVFSResult</link> (<link linkend="GnomeVFSMethodTruncateHandleFunc">*GnomeVFSMethodTruncateHandleFunc</link>)
  27                                             (<link linkend="GnomeVFSMethod">GnomeVFSMethod</link> *method,
  28                                              <link linkend="GnomeVFSMethodHandle">GnomeVFSMethodHandle</link> *handle,
  29                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length,
  30                                              <link linkend="GnomeVFSContext">GnomeVFSContext</link> *context);
  31 #define     <link linkend="VFS-METHOD-HAS-FUNC-CAPS">VFS_METHOD_HAS_FUNC</link>             (method,func)
  32 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-method-init">gnome_vfs_method_init</link>           (void);
  33 <link linkend="GnomeVFSMethod">GnomeVFSMethod</link>* <link linkend="gnome-vfs-method-get">gnome_vfs_method_get</link>        (const <link linkend="gchar">gchar</link> *name);
  34 <link linkend="GnomeVFSTransform">GnomeVFSTransform</link>* <link linkend="gnome-vfs-transform-get">gnome_vfs_transform_get</link>  (const <link linkend="gchar">gchar</link> *name);
  35 </synopsis>
  36 </refsynopsisdiv>
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46 <refsect1>
  47 <title>Description</title>
  48 <para>
  49
  50 </para>
  51 </refsect1>
  52
  53 <refsect1>
  54 <title>Details</title>
  55 <refsect2>
  56 <title><anchor id="GnomeVFSMethodInitFunc"/>GnomeVFSMethodInitFunc ()</title>
  57 <indexterm><primary>GnomeVFSMethodInitFunc</primary></indexterm><programlisting><link linkend="GnomeVFSMethod">GnomeVFSMethod</link>* (*GnomeVFSMethodInitFunc)   (const <link linkend="char">char</link> *method_name,
  58                                              const <link linkend="char">char</link> *config_args);</programlisting>
  59 <para>
  60
  61 </para><variablelist role="params">
  62 <varlistentry><term><parameter>method_name</parameter>&nbsp;:</term>
  63 <listitem><simpara>
  64 </simpara></listitem></varlistentry>
  65 <varlistentry><term><parameter>config_args</parameter>&nbsp;:</term>
  66 <listitem><simpara>
  67 </simpara></listitem></varlistentry>
  68 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
  69
  70
  71 </simpara></listitem></varlistentry>
  72 </variablelist></refsect2>
  73 <refsect2>
  74 <title><anchor id="GnomeVFSMethodShutdownFunc"/>GnomeVFSMethodShutdownFunc ()</title>
  75 <indexterm><primary>GnomeVFSMethodShutdownFunc</primary></indexterm><programlisting><link linkend="void">void</link>        (*GnomeVFSMethodShutdownFunc)   (<link linkend="GnomeVFSMethod">GnomeVFSMethod</link> *method);</programlisting>
  76 <para>
  77
  78 </para><variablelist role="params">
  79 <varlistentry><term><parameter>method</parameter>&nbsp;:</term>
  80 <listitem><simpara>
  81
  82
  83 </simpara></listitem></varlistentry>
  84 </variablelist></refsect2>
  85 <refsect2>
  86 <title><anchor id="GnomeVFSMethodTruncateFunc"/>GnomeVFSMethodTruncateFunc ()</title>
  87 <indexterm><primary>GnomeVFSMethodTruncateFunc</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> (*GnomeVFSMethodTruncateFunc)
  88                                             (<link linkend="GnomeVFSMethod">GnomeVFSMethod</link> *method,
  89                                              <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
  90                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length,
  91                                              <link linkend="GnomeVFSContext">GnomeVFSContext</link> *context);</programlisting>
  92 <para>
  93
  94 </para><variablelist role="params">
  95 <varlistentry><term><parameter>method</parameter>&nbsp;:</term>
  96 <listitem><simpara>
  97 </simpara></listitem></varlistentry>
  98 <varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
  99 <listitem><simpara>
 100 </simpara></listitem></varlistentry>
 101 <varlistentry><term><parameter>length</parameter>&nbsp;:</term>
 102 <listitem><simpara>
 103 </simpara></listitem></varlistentry>
 104 <varlistentry><term><parameter>context</parameter>&nbsp;:</term>
 105 <listitem><simpara>
 106 </simpara></listitem></varlistentry>
 107 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 108
 109
 110 </simpara></listitem></varlistentry>
 111 </variablelist></refsect2>
 112 <refsect2>
 113 <title><anchor id="GnomeVFSMethodTruncateHandleFunc"/>GnomeVFSMethodTruncateHandleFunc ()</title>
 114 <indexterm><primary>GnomeVFSMethodTruncateHandleFunc</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> (*GnomeVFSMethodTruncateHandleFunc)
 115                                             (<link linkend="GnomeVFSMethod">GnomeVFSMethod</link> *method,
 116                                              <link linkend="GnomeVFSMethodHandle">GnomeVFSMethodHandle</link> *handle,
 117                                              <link linkend="GnomeVFSFileSize">GnomeVFSFileSize</link> length,
 118                                              <link linkend="GnomeVFSContext">GnomeVFSContext</link> *context);</programlisting>
 119 <para>
 120
 121 </para><variablelist role="params">
 122 <varlistentry><term><parameter>method</parameter>&nbsp;:</term>
 123 <listitem><simpara>
 124 </simpara></listitem></varlistentry>
 125 <varlistentry><term><parameter>handle</parameter>&nbsp;:</term>
 126 <listitem><simpara>
 127 </simpara></listitem></varlistentry>
 128 <varlistentry><term><parameter>length</parameter>&nbsp;:</term>
 129 <listitem><simpara>
 130 </simpara></listitem></varlistentry>
 131 <varlistentry><term><parameter>context</parameter>&nbsp;:</term>
 132 <listitem><simpara>
 133 </simpara></listitem></varlistentry>
 134 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 135
 136
 137 </simpara></listitem></varlistentry>
 138 </variablelist></refsect2>
 139 <refsect2>
 140 <title><anchor id="VFS-METHOD-HAS-FUNC-CAPS"/>VFS_METHOD_HAS_FUNC()</title>
 141 <indexterm><primary>VFS_METHOD_HAS_FUNC</primary></indexterm><programlisting>#define VFS_METHOD_HAS_FUNC(method,func) ((((char *)&amp;((method)-&gt;func)) - ((char *)(method)) &lt; (method)-&gt;method_table_size) &amp;&amp; method-&gt;func != NULL)
 142 </programlisting>
 143 <para>
 144
 145 </para><variablelist role="params">
 146 <varlistentry><term><parameter>method</parameter>&nbsp;:</term>
 147 <listitem><simpara>
 148 </simpara></listitem></varlistentry>
 149 <varlistentry><term><parameter>func</parameter>&nbsp;:</term>
 150 <listitem><simpara>
 151
 152
 153 </simpara></listitem></varlistentry>
 154 </variablelist></refsect2>
 155 <refsect2>
 156 <title><anchor id="gnome-vfs-method-init"/>gnome_vfs_method_init ()</title>
 157 <indexterm><primary>gnome_vfs_method_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_method_init           (void);</programlisting>
 158 <para>
 159
 160 </para><variablelist role="params">
 161 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 162
 163
 164 </simpara></listitem></varlistentry>
 165 </variablelist></refsect2>
 166 <refsect2>
 167 <title><anchor id="gnome-vfs-method-get"/>gnome_vfs_method_get ()</title>
 168 <indexterm><primary>gnome_vfs_method_get</primary></indexterm><programlisting><link linkend="GnomeVFSMethod">GnomeVFSMethod</link>* gnome_vfs_method_get        (const <link linkend="gchar">gchar</link> *name);</programlisting>
 169 <para>
 170
 171 </para><variablelist role="params">
 172 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 173 <listitem><simpara>
 174 </simpara></listitem></varlistentry>
 175 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 176
 177
 178 </simpara></listitem></varlistentry>
 179 </variablelist></refsect2>
 180 <refsect2>
 181 <title><anchor id="gnome-vfs-transform-get"/>gnome_vfs_transform_get ()</title>
 182 <indexterm><primary>gnome_vfs_transform_get</primary></indexterm><programlisting><link linkend="GnomeVFSTransform">GnomeVFSTransform</link>* gnome_vfs_transform_get  (const <link linkend="gchar">gchar</link> *name);</programlisting>
 183 <para>
 184
 185 </para><variablelist role="params">
 186 <varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 187 <listitem><simpara>
 188 </simpara></listitem></varlistentry>
 189 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 190
 191
 192 </simpara></listitem></varlistentry>
 193 </variablelist></refsect2>
 194
 195 </refsect1>
 196
 197
 198
 199
 200 </refentry>