ftp://ftp.redhat.com/pub/redhat/linux/rawhide/SRPMS/SRPMS/gnome-vfs2-2.3.8-1.src.rpm
[gnome-vfs-httpcaptive.git] / doc / html / gnome-vfs-20-gnome-vfs-method.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gnome-vfs-method</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.0"><meta name="generator" content="GTK-Doc V1.1 (XML mode)"><style type="text/css">
2         .synopsis, .classsynopsis {
3             background: #eeeeee;
4             border: solid 1px #aaaaaa;
5             padding: 0.5em;
6         }
7         .programlisting {
8             background: #eeeeff;
9             border: solid 1px #aaaaff;
10             padding: 0.5em;
11         }
12         .variablelist {
13             padding: 4px;
14             margin-left: 3em;
15         }
16         .navigation {
17             background: #ffeeee;
18             border: solid 1px #ffaaaa;
19             margin-top: 0.5em;
20             margin-bottom: 0.5em;
21         }
22         .navigation a {
23             color: #770000;
24         }
25         .navigation a:visited {
26             color: #550000;
27         }
28         .navigation .title {
29             font-size: 200%;
30         }
31       </style><link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library"><link rel="up" href="modules.html" title="Filesystem Modules"><link rel="previous" href="gnome-vfs-20-gnome-vfs-mime.html" title="MIME typing"><link rel="next" href="gnome-vfs-20-gnome-vfs-module.html" title="gnome-vfs-module"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="gnome-vfs-20-gnome-vfs-mime.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="modules.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th><td><a accesskey="n" href="gnome-vfs-20-gnome-vfs-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="gnome-vfs-20-gnome-vfs-method"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">gnome-vfs-method</span></h2><p>gnome-vfs-method &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
32
33
34
35 GnomeVFSMethod* (<a href="gnome-vfs-20-gnome-vfs-method.html#GnomeVFSMethodInitFunc">*GnomeVFSMethodInitFunc</a>)   (const char *method_name,
36                                              const char *config_args);
37 void        (<a href="gnome-vfs-20-gnome-vfs-method.html#GnomeVFSMethodShutdownFunc">*GnomeVFSMethodShutdownFunc</a>)   (GnomeVFSMethod *method);
38 <a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> (<a href="gnome-vfs-20-gnome-vfs-method.html#GnomeVFSMethodTruncateFunc">*GnomeVFSMethodTruncateFunc</a>)
39                                             (GnomeVFSMethod *method,
40                                              GnomeVFSURI *uri,
41                                              <a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> length,
42                                              GnomeVFSContext *context);
43 <a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> (<a href="gnome-vfs-20-gnome-vfs-method.html#GnomeVFSMethodTruncateHandleFunc">*GnomeVFSMethodTruncateHandleFunc</a>)
44                                             (GnomeVFSMethod *method,
45                                              GnomeVFSMethodHandle *handle,
46                                              <a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> length,
47                                              GnomeVFSContext *context);
48 #define     <a href="gnome-vfs-20-gnome-vfs-method.html#VFS-METHOD-HAS-FUNC-CAPS">VFS_METHOD_HAS_FUNC</a>             (method,func)
49 <a
50 href="../glib/glib-Basic-Types.html#gboolean"
51 >gboolean</a>    <a href="gnome-vfs-20-gnome-vfs-method.html#gnome-vfs-method-init">gnome_vfs_method_init</a>           (void);
52 GnomeVFSMethod* <a href="gnome-vfs-20-gnome-vfs-method.html#gnome-vfs-method-get">gnome_vfs_method_get</a>        (const <a
53 href="../glib/glib-Basic-Types.html#gchar"
54 >gchar</a> *name);
55 GnomeVFSTransform* <a href="gnome-vfs-20-gnome-vfs-method.html#gnome-vfs-transform-get">gnome_vfs_transform_get</a>  (const <a
56 href="../glib/glib-Basic-Types.html#gchar"
57 >gchar</a> *name);
58 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
59
60 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="GnomeVFSMethodInitFunc"></a>GnomeVFSMethodInitFunc ()</h3><a class="indexterm" name="id2976090"></a><pre class="programlisting">GnomeVFSMethod* (*GnomeVFSMethodInitFunc)   (const char *method_name,
61                                              const char *config_args);</pre><p>
62
63 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>method_name</tt></i> :</span></td><td>
64 </td></tr><tr><td><span class="term"><i class="parameter"><tt>config_args</tt></i> :</span></td><td>
65 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
66
67
68 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSMethodShutdownFunc"></a>GnomeVFSMethodShutdownFunc ()</h3><a class="indexterm" name="id2976200"></a><pre class="programlisting">void        (*GnomeVFSMethodShutdownFunc)   (GnomeVFSMethod *method);</pre><p>
69
70 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>method</tt></i> :</span></td><td>
71
72
73 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSMethodTruncateFunc"></a>GnomeVFSMethodTruncateFunc ()</h3><a class="indexterm" name="id2976270"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> (*GnomeVFSMethodTruncateFunc)
74                                             (GnomeVFSMethod *method,
75                                              GnomeVFSURI *uri,
76                                              <a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> length,
77                                              GnomeVFSContext *context);</pre><p>
78
79 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>method</tt></i> :</span></td><td>
80 </td></tr><tr><td><span class="term"><i class="parameter"><tt>uri</tt></i> :</span></td><td>
81 </td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i> :</span></td><td>
82 </td></tr><tr><td><span class="term"><i class="parameter"><tt>context</tt></i> :</span></td><td>
83 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
84
85
86 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSMethodTruncateHandleFunc"></a>GnomeVFSMethodTruncateHandleFunc ()</h3><a class="indexterm" name="id2976431"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> (*GnomeVFSMethodTruncateHandleFunc)
87                                             (GnomeVFSMethod *method,
88                                              GnomeVFSMethodHandle *handle,
89                                              <a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> length,
90                                              GnomeVFSContext *context);</pre><p>
91
92 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>method</tt></i> :</span></td><td>
93 </td></tr><tr><td><span class="term"><i class="parameter"><tt>handle</tt></i> :</span></td><td>
94 </td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i> :</span></td><td>
95 </td></tr><tr><td><span class="term"><i class="parameter"><tt>context</tt></i> :</span></td><td>
96 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
97
98
99 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="VFS-METHOD-HAS-FUNC-CAPS"></a>VFS_METHOD_HAS_FUNC()</h3><a class="indexterm" name="id2976592"></a><pre class="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)
100 </pre><p>
101
102 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>method</tt></i> :</span></td><td>
103 </td></tr><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td>
104
105
106 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-method-init"></a>gnome_vfs_method_init ()</h3><a class="indexterm" name="id2976668"></a><pre class="programlisting"><a
107 href="../glib/glib-Basic-Types.html#gboolean"
108 >gboolean</a>    gnome_vfs_method_init           (void);</pre><p>
109
110 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
111
112
113 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-method-get"></a>gnome_vfs_method_get ()</h3><a class="indexterm" name="id2976726"></a><pre class="programlisting">GnomeVFSMethod* gnome_vfs_method_get        (const <a
114 href="../glib/glib-Basic-Types.html#gchar"
115 >gchar</a> *name);</pre><p>
116
117 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td>
118 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
119
120
121 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-transform-get"></a>gnome_vfs_transform_get ()</h3><a class="indexterm" name="id2976808"></a><pre class="programlisting">GnomeVFSTransform* gnome_vfs_transform_get  (const <a
122 href="../glib/glib-Basic-Types.html#gchar"
123 >gchar</a> *name);</pre><p>
124
125 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td>
126 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
127
128
129 </td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="gnome-vfs-20-gnome-vfs-mime.html"><b>&lt;&lt; MIME typing</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-20-gnome-vfs-module.html"><b>gnome-vfs-module &gt;&gt;</b></a></td></tr></table></body></html>