← Back to branch summary

~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

« back to all changes in this revision

Viewing changes to doc/html/gnome-vfs-2.0-gnome-vfs-method.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-17 16:12:58 UTC
  • mfrom: (0.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317161258-px3a2czt9g2ktjz3
Tags: 1:2.24.1-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/gnome-vfs-2.0-gnome-vfs-method.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>gnome-vfs-method</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
 
7
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
 
8
<link rel="up" href="modules.html" title="Filesystem Modules">
 
9
<link rel="prev" href="gnome-vfs-writing-modules.html" title="Writing Modules">
 
10
<link rel="next" href="gnome-vfs-2.0-gnome-vfs-module.html" title="gnome-vfs-module">
 
11
<meta name="generator" content="GTK-Doc V1.12 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="about.html" title="Introduction to GnomeVFS">
 
14
<link rel="chapter" href="data-types.html" title="Basic Data Types">
 
15
<link rel="chapter" href="gnome-vfs-basic-file-ops.html" title="File Operations">
 
16
<link rel="chapter" href="gnome-vfs-directory-ops.html" title="Directory-Specific Operations">
 
17
<link rel="chapter" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
 
18
<link rel="chapter" href="gnome-vfs-file-async-ops.html" title="Asynchronous Operations">
 
19
<link rel="chapter" href="volumes.html" title="Volumes and Drives Handling">
 
20
<link rel="chapter" href="networking.html" title="Networking">
 
21
<link rel="chapter" href="mime-registry.html" title="MIME Registry">
 
22
<link rel="chapter" href="modules.html" title="Filesystem Modules">
 
23
</head>
 
24
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
25
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
26
<tr valign="middle">
 
27
<td><a accesskey="p" href="gnome-vfs-writing-modules.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
28
<td><a accesskey="u" href="modules.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
29
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
30
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
 
31
<td><a accesskey="n" href="gnome-vfs-2.0-gnome-vfs-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
32
</tr>
 
33
<tr><td colspan="5" class="shortcuts">
 
34
<a href="#gnome-vfs-2.0-gnome-vfs-method.synopsis" class="shortcut">Top</a>
 
35
                   | 
 
36
                  <a href="#gnome-vfs-2.0-gnome-vfs-method.description" class="shortcut">Description</a>
 
37
</td></tr>
 
38
</table>
 
39
<div class="refentry" lang="en">
 
40
<a name="gnome-vfs-2.0-gnome-vfs-method"></a><div class="titlepage"></div>
 
41
<div class="refnamediv"><table width="100%"><tr>
 
42
<td valign="top">
 
43
<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-method.top_of_page"></a>gnome-vfs-method</span></h2>
 
44
<p>gnome-vfs-method</p>
 
45
</td>
 
46
<td valign="top" align="right"></td>
 
47
</tr></table></div>
 
48
<div class="refsynopsisdiv">
 
49
<a name="gnome-vfs-2.0-gnome-vfs-method.synopsis"></a><h2>Synopsis</h2>
 
50
<pre class="synopsis">
 
51
GnomeVFSMethod *    (<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSMethodInitFunc" title="GnomeVFSMethodInitFunc ()">*GnomeVFSMethodInitFunc</a>)           (const char *method_name,
 
52
                                                         const char *config_args);
 
53
void                (<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSMethodShutdownFunc" title="GnomeVFSMethodShutdownFunc ()">*GnomeVFSMethodShutdownFunc</a>)       (GnomeVFSMethod *method);
 
54
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      (<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSMethodTruncateFunc" title="GnomeVFSMethodTruncateFunc ()">*GnomeVFSMethodTruncateFunc</a>)       (GnomeVFSMethod *method,
 
55
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
 
56
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> length,
 
57
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext">GnomeVFSContext</a> *context);
 
58
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      (<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSMethodTruncateHandleFunc" title="GnomeVFSMethodTruncateHandleFunc ()">*GnomeVFSMethodTruncateHandleFunc</a>) (GnomeVFSMethod *method,
 
59
                                                         GnomeVFSMethodHandle *handle,
 
60
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> length,
 
61
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext">GnomeVFSContext</a> *context);
 
62
#define             <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#VFS-METHOD-HAS-FUNC:CAPS" title="VFS_METHOD_HAS_FUNC()">VFS_METHOD_HAS_FUNC</a>                 (method,func)
 
63
gboolean            <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#gnome-vfs-method-init" title="gnome_vfs_method_init ()">gnome_vfs_method_init</a>               (void);
 
64
GnomeVFSMethod *    <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#gnome-vfs-method-get" title="gnome_vfs_method_get ()">gnome_vfs_method_get</a>                (const gchar *name);
 
65
typedef             <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform">GnomeVFSTransform</a>;
 
66
<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform">GnomeVFSTransform</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#gnome-vfs-transform-get" title="gnome_vfs_transform_get ()">gnome_vfs_transform_get</a>             (const gchar *name);
 
67
</pre>
 
68
</div>
 
69
<div class="refsect1" lang="en">
 
70
<a name="gnome-vfs-2.0-gnome-vfs-method.description"></a><h2>Description</h2>
 
71
<p>
 
72
</p>
 
73
</div>
 
74
<div class="refsect1" lang="en">
 
75
<a name="gnome-vfs-2.0-gnome-vfs-method.details"></a><h2>Details</h2>
 
76
<div class="refsect2" lang="en">
 
77
<a name="GnomeVFSMethodInitFunc"></a><h3>GnomeVFSMethodInitFunc ()</h3>
 
78
<pre class="programlisting">GnomeVFSMethod *    (*GnomeVFSMethodInitFunc)           (const char *method_name,
 
79
                                                         const char *config_args);</pre>
 
80
<p>
 
81
</p>
 
82
<div class="variablelist"><table border="0">
 
83
<col align="left" valign="top">
 
84
<tbody>
 
85
<tr>
 
86
<td><p><span class="term"><em class="parameter"><code>method_name</code></em> :</span></p></td>
 
87
<td>
 
88
</td>
 
89
</tr>
 
90
<tr>
 
91
<td><p><span class="term"><em class="parameter"><code>config_args</code></em> :</span></p></td>
 
92
<td>
 
93
</td>
 
94
</tr>
 
95
<tr>
 
96
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
97
<td>
 
98
</td>
 
99
</tr>
 
100
</tbody>
 
101
</table></div>
 
102
</div>
 
103
<hr>
 
104
<div class="refsect2" lang="en">
 
105
<a name="GnomeVFSMethodShutdownFunc"></a><h3>GnomeVFSMethodShutdownFunc ()</h3>
 
106
<pre class="programlisting">void                (*GnomeVFSMethodShutdownFunc)       (GnomeVFSMethod *method);</pre>
 
107
<p>
 
108
</p>
 
109
<div class="variablelist"><table border="0">
 
110
<col align="left" valign="top">
 
111
<tbody><tr>
 
112
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 
113
<td>
 
114
</td>
 
115
</tr></tbody>
 
116
</table></div>
 
117
</div>
 
118
<hr>
 
119
<div class="refsect2" lang="en">
 
120
<a name="GnomeVFSMethodTruncateFunc"></a><h3>GnomeVFSMethodTruncateFunc ()</h3>
 
121
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      (*GnomeVFSMethodTruncateFunc)       (GnomeVFSMethod *method,
 
122
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
 
123
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> length,
 
124
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext">GnomeVFSContext</a> *context);</pre>
 
125
<p>
 
126
</p>
 
127
<div class="variablelist"><table border="0">
 
128
<col align="left" valign="top">
 
129
<tbody>
 
130
<tr>
 
131
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 
132
<td>
 
133
</td>
 
134
</tr>
 
135
<tr>
 
136
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
 
137
<td>
 
138
</td>
 
139
</tr>
 
140
<tr>
 
141
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
 
142
<td>
 
143
</td>
 
144
</tr>
 
145
<tr>
 
146
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
 
147
<td>
 
148
</td>
 
149
</tr>
 
150
<tr>
 
151
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
152
<td>
 
153
</td>
 
154
</tr>
 
155
</tbody>
 
156
</table></div>
 
157
</div>
 
158
<hr>
 
159
<div class="refsect2" lang="en">
 
160
<a name="GnomeVFSMethodTruncateHandleFunc"></a><h3>GnomeVFSMethodTruncateHandleFunc ()</h3>
 
161
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      (*GnomeVFSMethodTruncateHandleFunc) (GnomeVFSMethod *method,
 
162
                                                         GnomeVFSMethodHandle *handle,
 
163
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> length,
 
164
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext">GnomeVFSContext</a> *context);</pre>
 
165
<p>
 
166
</p>
 
167
<div class="variablelist"><table border="0">
 
168
<col align="left" valign="top">
 
169
<tbody>
 
170
<tr>
 
171
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 
172
<td>
 
173
</td>
 
174
</tr>
 
175
<tr>
 
176
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
 
177
<td>
 
178
</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
 
182
<td>
 
183
</td>
 
184
</tr>
 
185
<tr>
 
186
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
 
187
<td>
 
188
</td>
 
189
</tr>
 
190
<tr>
 
191
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
192
<td>
 
193
</td>
 
194
</tr>
 
195
</tbody>
 
196
</table></div>
 
197
</div>
 
198
<hr>
 
199
<div class="refsect2" lang="en">
 
200
<a name="VFS-METHOD-HAS-FUNC:CAPS"></a><h3>VFS_METHOD_HAS_FUNC()</h3>
 
201
<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)
 
202
</pre>
 
203
<p>
 
204
</p>
 
205
<div class="variablelist"><table border="0">
 
206
<col align="left" valign="top">
 
207
<tbody>
 
208
<tr>
 
209
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
 
210
<td>
 
211
</td>
 
212
</tr>
 
213
<tr>
 
214
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
 
215
<td>
 
216
</td>
 
217
</tr>
 
218
</tbody>
 
219
</table></div>
 
220
</div>
 
221
<hr>
 
222
<div class="refsect2" lang="en">
 
223
<a name="gnome-vfs-method-init"></a><h3>gnome_vfs_method_init ()</h3>
 
224
<pre class="programlisting">gboolean            gnome_vfs_method_init               (void);</pre>
 
225
<p>
 
226
Initializes the gnome-vfs methods. If already initialized then will simply return
 
227
<code class="literal">TRUE</code>.</p>
 
228
<p>
 
229
</p>
 
230
<div class="variablelist"><table border="0">
 
231
<col align="left" valign="top">
 
232
<tbody><tr>
 
233
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
234
<td> Returns <code class="literal">TRUE</code>.
 
235
</td>
 
236
</tr></tbody>
 
237
</table></div>
 
238
</div>
 
239
<hr>
 
240
<div class="refsect2" lang="en">
 
241
<a name="gnome-vfs-method-get"></a><h3>gnome_vfs_method_get ()</h3>
 
242
<pre class="programlisting">GnomeVFSMethod *    gnome_vfs_method_get                (const gchar *name);</pre>
 
243
<p>
 
244
</p>
 
245
<div class="variablelist"><table border="0">
 
246
<col align="left" valign="top">
 
247
<tbody>
 
248
<tr>
 
249
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
250
<td> name of the protocol.
 
251
</td>
 
252
</tr>
 
253
<tr>
 
254
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
255
<td>the method handle for the given protocol <em class="parameter"><code>name</code></em>. <em class="parameter"><code>name</code></em> could be any protocol
 
256
which gnome-vfs implements. Like ftp, http, smb etc..
 
257
</td>
 
258
</tr>
 
259
</tbody>
 
260
</table></div>
 
261
</div>
 
262
<hr>
 
263
<div class="refsect2" lang="en">
 
264
<a name="GnomeVFSTransform"></a><h3>GnomeVFSTransform</h3>
 
265
<pre class="programlisting">typedef struct GnomeVFSTransform GnomeVFSTransform;
 
266
</pre>
 
267
<p>
 
268
</p>
 
269
</div>
 
270
<hr>
 
271
<div class="refsect2" lang="en">
 
272
<a name="gnome-vfs-transform-get"></a><h3>gnome_vfs_transform_get ()</h3>
 
273
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform">GnomeVFSTransform</a> * gnome_vfs_transform_get             (const gchar *name);</pre>
 
274
<p>
 
275
Get the transform for the method <em class="parameter"><code>name</code></em>.</p>
 
276
<p>
 
277
</p>
 
278
<div class="variablelist"><table border="0">
 
279
<col align="left" valign="top">
 
280
<tbody>
 
281
<tr>
 
282
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
283
<td> name of the method to get the transform of.
 
284
</td>
 
285
</tr>
 
286
<tr>
 
287
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
288
<td> a <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform"><span class="type">GnomeVFSTransform</span></a> handle for <em class="parameter"><code>name</code></em>.
 
289
</td>
 
290
</tr>
 
291
</tbody>
 
292
</table></div>
 
293
</div>
 
294
</div>
 
295
</div>
 
296
<div class="footer">
 
297
<hr>
 
298
          Generated by GTK-Doc V1.12</div>
 
299
</body>
 
300
</html>