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-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-gnome-vfs-mime.html" title="
32 MIME typing"><link rel="next" href="gnome-vfs-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-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-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-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">
33
34
35
36 GnomeVFSMethod* (<a href="gnome-vfs-gnome-vfs-method.html#GnomeVFSMethodInitFunc">*GnomeVFSMethodInitFunc</a>)   (const char *method_name,
37                                              const char *config_args);
38 void        (<a href="gnome-vfs-gnome-vfs-method.html#GnomeVFSMethodShutdownFunc">*GnomeVFSMethodShutdownFunc</a>)   (GnomeVFSMethod *method);
39 <a href="gnome-vfs-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> (<a href="gnome-vfs-gnome-vfs-method.html#GnomeVFSMethodTruncateFunc">*GnomeVFSMethodTruncateFunc</a>)
40                                             (GnomeVFSMethod *method,
41                                              GnomeVFSURI *uri,
42                                              <a href="gnome-vfs-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> length,
43                                              GnomeVFSContext *context);
44 <a href="gnome-vfs-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> (<a href="gnome-vfs-gnome-vfs-method.html#GnomeVFSMethodTruncateHandleFunc">*GnomeVFSMethodTruncateHandleFunc</a>)
45                                             (GnomeVFSMethod *method,
46                                              GnomeVFSMethodHandle *handle,
47                                              <a href="gnome-vfs-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> length,
48                                              GnomeVFSContext *context);
49 #define     <a href="gnome-vfs-gnome-vfs-method.html#VFS-METHOD-HAS-FUNC-CAPS">VFS_METHOD_HAS_FUNC</a>             (method,func)
50 <a
51 href="../glib/glib-Basic-Types.html#gboolean"
52 >gboolean</a>    <a href="gnome-vfs-gnome-vfs-method.html#gnome-vfs-method-init">gnome_vfs_method_init</a>           (void);
53 GnomeVFSMethod* <a href="gnome-vfs-gnome-vfs-method.html#gnome-vfs-method-get">gnome_vfs_method_get</a>        (const <a
54 href="../glib/glib-Basic-Types.html#gchar"
55 >gchar</a> *name);
56 GnomeVFSTransform* <a href="gnome-vfs-gnome-vfs-method.html#gnome-vfs-transform-get">gnome_vfs_transform_get</a>  (const <a
57 href="../glib/glib-Basic-Types.html#gchar"
58 >gchar</a> *name);
59 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
60
61 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="GnomeVFSMethodInitFunc"></a>GnomeVFSMethodInitFunc ()</h3><pre class="programlisting">GnomeVFSMethod* (*GnomeVFSMethodInitFunc)   (const char *method_name,
62                                              const char *config_args);</pre><p>
63
64 </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>
65 </td></tr><tr><td><span class="term"><i class="parameter"><tt>config_args</tt></i> :</span></td><td>
66 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
67
68
69 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSMethodShutdownFunc"></a>GnomeVFSMethodShutdownFunc ()</h3><pre class="programlisting">void        (*GnomeVFSMethodShutdownFunc)   (GnomeVFSMethod *method);</pre><p>
70
71 </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>
72
73
74 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSMethodTruncateFunc"></a>GnomeVFSMethodTruncateFunc ()</h3><pre class="programlisting"><a href="gnome-vfs-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> (*GnomeVFSMethodTruncateFunc)
75                                             (GnomeVFSMethod *method,
76                                              GnomeVFSURI *uri,
77                                              <a href="gnome-vfs-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> length,
78                                              GnomeVFSContext *context);</pre><p>
79
80 </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>
81 </td></tr><tr><td><span class="term"><i class="parameter"><tt>uri</tt></i> :</span></td><td>
82 </td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i> :</span></td><td>
83 </td></tr><tr><td><span class="term"><i class="parameter"><tt>context</tt></i> :</span></td><td>
84 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
85
86
87 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSMethodTruncateHandleFunc"></a>GnomeVFSMethodTruncateHandleFunc ()</h3><pre class="programlisting"><a href="gnome-vfs-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> (*GnomeVFSMethodTruncateHandleFunc)
88                                             (GnomeVFSMethod *method,
89                                              GnomeVFSMethodHandle *handle,
90                                              <a href="gnome-vfs-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> length,
91                                              GnomeVFSContext *context);</pre><p>
92
93 </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>
94 </td></tr><tr><td><span class="term"><i class="parameter"><tt>handle</tt></i> :</span></td><td>
95 </td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i> :</span></td><td>
96 </td></tr><tr><td><span class="term"><i class="parameter"><tt>context</tt></i> :</span></td><td>
97 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
98
99
100 </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><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)
101 </pre><p>
102
103 </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>
104 </td></tr><tr><td><span class="term"><i class="parameter"><tt>func</tt></i> :</span></td><td>
105
106
107 </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><pre class="programlisting"><a
108 href="../glib/glib-Basic-Types.html#gboolean"
109 >gboolean</a>    gnome_vfs_method_init           (void);</pre><p>
110
111 </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>
112
113
114 </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><pre class="programlisting">GnomeVFSMethod* gnome_vfs_method_get        (const <a
115 href="../glib/glib-Basic-Types.html#gchar"
116 >gchar</a> *name);</pre><p>
117
118 </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>
119 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
120
121
122 </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><pre class="programlisting">GnomeVFSTransform* gnome_vfs_transform_get  (const <a
123 href="../glib/glib-Basic-Types.html#gchar"
124 >gchar</a> *name);</pre><p>
125
126 </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>
127 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
128
129
130 </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-gnome-vfs-mime.html"><b>&lt;&lt; 
131 MIME typing</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-gnome-vfs-module.html"><b>gnome-vfs-module &gt;&gt;</b></a></td></tr></table></body></html>