1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>gnome-vfs-module</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
<link rel="start" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
8
8
<link rel="up" href="modules.html" title="Filesystem Modules">
9
9
<link rel="prev" href="gnome-vfs-20-gnome-vfs-method.html" title="gnome-vfs-method">
10
10
<link rel="next" href="gnome-vfs-20-gnome-vfs-module-shared.html" title="gnome-vfs-module-shared">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="about.html" title="Introduction to GnomeVFS">
14
14
<link rel="chapter" href="data-types.html" title="Basic Data Types">
30
30
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
31
31
<td><a accesskey="n" href="gnome-vfs-20-gnome-vfs-module-shared.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
33
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2739204" class="shortcut">Top</a>
35
<a href="#id2739299" class="shortcut">Description</a></nobr></td></tr>
33
<tr><td colspan="5" class="shortcuts"><nobr><a href="#gnome-vfs-20-gnome-vfs-module.synopsis" class="shortcut">Top</a>
35
<a href="#gnome-vfs-20-gnome-vfs-module.description" class="shortcut">Description</a></nobr></td></tr>
37
37
<div class="refentry" lang="en">
38
38
<a name="gnome-vfs-20-gnome-vfs-module"></a><div class="titlepage"></div>
39
39
<div class="refnamediv"><table width="100%"><tr>
42
<a name="id2739204"></a><span class="refentrytitle">gnome-vfs-module</span>
41
<h2><span class="refentrytitle"><a name="gnome-vfs-20-gnome-vfs-module.top_of_page"></a>gnome-vfs-module</span></h2>
44
42
<p>gnome-vfs-module</p>
46
44
<td valign="top" align="right"></td>
47
45
</tr></table></div>
48
46
<div class="refsynopsisdiv">
47
<a name="gnome-vfs-20-gnome-vfs-module.synopsis"></a><h2>Synopsis</h2>
50
48
<pre class="synopsis">
54
GnomeVFSMethod* <a href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-init">vfs_module_init</a> (const char *method_name,
56
<a href="gnome-vfs-20-gnome-vfs-method.html#GnomeVFSTransform">GnomeVFSTransform</a>* <a href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-transform">vfs_module_transform</a> (const char *method_name,
58
void <a href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-shutdown">vfs_module_shutdown</a> (GnomeVFSMethod *method);
49
GnomeVFSMethod* <a class="link" href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-init" title="vfs_module_init ()">vfs_module_init</a> (const char *method_name,
51
<a class="link" href="gnome-vfs-20-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform">GnomeVFSTransform</a>* <a class="link" href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-transform" title="vfs_module_transform ()">vfs_module_transform</a> (const char *method_name,
53
void <a class="link" href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-shutdown" title="vfs_module_shutdown ()">vfs_module_shutdown</a> (GnomeVFSMethod *method);
61
56
<div class="refsect1" lang="en">
62
<a name="id2739299"></a><h2>Description</h2>
57
<a name="gnome-vfs-20-gnome-vfs-module.description"></a><h2>Description</h2>
67
62
<div class="refsect1" lang="en">
68
<a name="id2739313"></a><h2>Details</h2>
63
<a name="gnome-vfs-20-gnome-vfs-module.details"></a><h2>Details</h2>
69
64
<div class="refsect2" lang="en">
70
<a name="id2739324"></a><h3>
71
<a name="vfs-module-init"></a>vfs_module_init ()</h3>
72
<a class="indexterm" name="id2739336"></a><pre class="programlisting">GnomeVFSMethod* vfs_module_init (const char *method_name,
65
<a name="vfs-module-init"></a><h3>vfs_module_init ()</h3>
66
<pre class="programlisting">GnomeVFSMethod* vfs_module_init (const char *method_name,
73
67
const char *args);</pre>
75
69
Standard extern call implemented by each filesystem module. This is called
83
77
<col align="left" valign="top">
86
<td><span class="term"><em class="parameter"><code>method_name</code></em> :</span></td>
80
<td><p><span class="term"><em class="parameter"><code>method_name</code></em> :</span></p></td>
87
81
<td> name of the method that invoked this module (e.g. "http", "ftp", "file").
91
<td><span class="term"><em class="parameter"><code>args</code></em> :</span></td>
85
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
92
86
<td> not used by most modules, but potential arguments for creating the module (could
93
87
be a file to point at, for example)
97
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
91
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
98
92
<td> the module symbol table, pointing to the appropriate calls for
106
100
<div class="refsect2" lang="en">
107
<a name="id2739427"></a><h3>
108
<a name="vfs-module-transform"></a>vfs_module_transform ()</h3>
109
<a class="indexterm" name="id2739440"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-method.html#GnomeVFSTransform">GnomeVFSTransform</a>* vfs_module_transform (const char *method_name,
101
<a name="vfs-module-transform"></a><h3>vfs_module_transform ()</h3>
102
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform">GnomeVFSTransform</a>* vfs_module_transform (const char *method_name,
110
103
const char *args);</pre>
112
105
Shift an already instanced module to a new method name. This call is not implemented
118
111
<col align="left" valign="top">
121
<td><span class="term"><em class="parameter"><code>method_name</code></em> :</span></td>
114
<td><p><span class="term"><em class="parameter"><code>method_name</code></em> :</span></p></td>
122
115
<td> name of the method that invoked this module (e.g. "http", "ftp", "file").
126
<td><span class="term"><em class="parameter"><code>args</code></em> :</span></td>
119
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
127
120
<td> not used by most modules, but potential arguments for creating the module (could
128
121
be a file to point at, for example)
132
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
125
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
133
126
<td> the module symbol table, pointing to the appropriate calls for
141
134
<div class="refsect2" lang="en">
142
<a name="id2739529"></a><h3>
143
<a name="vfs-module-shutdown"></a>vfs_module_shutdown ()</h3>
144
<a class="indexterm" name="id2739542"></a><pre class="programlisting">void vfs_module_shutdown (GnomeVFSMethod *method);</pre>
135
<a name="vfs-module-shutdown"></a><h3>vfs_module_shutdown ()</h3>
136
<pre class="programlisting">void vfs_module_shutdown (GnomeVFSMethod *method);</pre>
146
138
Called to tell a module to end any active operations, free all used memory,
147
139
and close any connections (as appropriate) or resources.</p>
151
143
<div class="variablelist"><table border="0">
152
144
<col align="left" valign="top">
154
<td><span class="term"><em class="parameter"><code>method</code></em> :</span></td>
146
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
155
147
<td> the symbol table of the module being shut down
added
removed
doc/html/gnome-vfs-20-gnome-vfs-module.html
