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-module.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >module</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64
8 "><LINK
9 REL="HOME"
10 TITLE="GnomeVFS - Filesystem Abstraction library"
11 HREF="index.html"><LINK
12 REL="UP"
13 TITLE="Filesystem Modules"
14 HREF="modules.html"><LINK
15 REL="PREVIOUS"
16 TITLE="module-shared"
17 HREF="gnome-vfs-module-shared.html"><LINK
18 REL="NEXT"
19 TITLE="Module Callbacks (Module API)"
20 HREF="gnome-vfs-module-callback-module-api.html"></HEAD
21 ><BODY
22 CLASS="REFENTRY"
23 BGCOLOR="#FFFFFF"
24 TEXT="#000000"
25 LINK="#0000FF"
26 VLINK="#840084"
27 ALINK="#0000FF"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 WIDTH="100%"
32 BORDER="0"
33 BGCOLOR="#000000"
34 CELLPADDING="1"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="4"
39 ALIGN="center"
40 ><FONT
41 COLOR="#FFFFFF"
42 SIZE="5"
43 >GnomeVFS - Filesystem Abstraction library</FONT
44 ></TH
45 ></TR
46 ><TR
47 ><TD
48 WIDTH="25%"
49 BGCOLOR="#C00000"
50 ALIGN="left"
51 ><A
52 HREF="gnome-vfs-module-shared.html"
53 ><FONT
54 COLOR="#FFFFFF"
55 SIZE="3"
56 ><B
57 >&#60;&#60;&#60; Previous Page</B
58 ></FONT
59 ></A
60 ></TD
61 ><TD
62 WIDTH="25%"
63 BGCOLOR="#0000C0"
64 ALIGN="center"
65 ><FONT
66 COLOR="#FFFFFF"
67 SIZE="3"
68 ><B
69 ><A
70 HREF="index.html"
71 ><FONT
72 COLOR="#FFFFFF"
73 SIZE="3"
74 ><B
75 >Home</B
76 ></FONT
77 ></A
78 ></B
79 ></FONT
80 ></TD
81 ><TD
82 WIDTH="25%"
83 BGCOLOR="#00C000"
84 ALIGN="center"
85 ><FONT
86 COLOR="#FFFFFF"
87 SIZE="3"
88 ><B
89 ><A
90 HREF="modules.html"
91 ><FONT
92 COLOR="#FFFFFF"
93 SIZE="3"
94 ><B
95 >Up</B
96 ></FONT
97 ></A
98 ></B
99 ></FONT
100 ></TD
101 ><TD
102 WIDTH="25%"
103 BGCOLOR="#C00000"
104 ALIGN="right"
105 ><A
106 HREF="gnome-vfs-module-callback-module-api.html"
107 ><FONT
108 COLOR="#FFFFFF"
109 SIZE="3"
110 ><B
111 >Next Page &#62;&#62;&#62;</B
112 ></FONT
113 ></A
114 ></TD
115 ></TR
116 ></TABLE
117 ></DIV
118 ><H1
119 ><A
120 NAME="GNOME-VFS-MODULE"
121 >module</A
122 ></H1
123 ><DIV
124 CLASS="REFNAMEDIV"
125 ><A
126 NAME="AEN8389"
127 ></A
128 ><H2
129 >Name</H2
130 >module&nbsp;--&nbsp;</DIV
131 ><DIV
132 CLASS="REFSYNOPSISDIV"
133 ><A
134 NAME="AEN8392"
135 ></A
136 ><H2
137 >Synopsis</H2
138 ><TABLE
139 BORDER="0"
140 BGCOLOR="#D6E8FF"
141 WIDTH="100%"
142 CELLPADDING="6"
143 ><TR
144 ><TD
145 ><PRE
146 CLASS="SYNOPSIS"
147 >&#13;
148
149 #define     <A
150 HREF="gnome-vfs-module.html#GNOME-VFS-MODULE-INIT-CAPS"
151 >GNOME_VFS_MODULE_INIT</A
152 >
153 #define     <A
154 HREF="gnome-vfs-module.html#GNOME-VFS-MODULE-TRANSFORM-CAPS"
155 >GNOME_VFS_MODULE_TRANSFORM</A
156 >
157 #define     <A
158 HREF="gnome-vfs-module.html#GNOME-VFS-MODULE-SHUTDOWN-CAPS"
159 >GNOME_VFS_MODULE_SHUTDOWN</A
160 >
161 GnomeVFSMethod* <A
162 HREF="gnome-vfs-module.html#VFS-MODULE-INIT"
163 >vfs_module_init</A
164 >             (const char *method_name,
165                                              const char *args);
166 GnomeVFSTransform* <A
167 HREF="gnome-vfs-module.html#VFS-MODULE-TRANSFORM"
168 >vfs_module_transform</A
169 >     (const char *method_name,
170                                              const char *args);
171 void        <A
172 HREF="gnome-vfs-module.html#VFS-MODULE-SHUTDOWN"
173 >vfs_module_shutdown</A
174 >             (GnomeVFSMethod *method);</PRE
175 ></TD
176 ></TR
177 ></TABLE
178 ></DIV
179 ><DIV
180 CLASS="REFSECT1"
181 ><A
182 NAME="AEN8404"
183 ></A
184 ><H2
185 >Description</H2
186 ><P
187 ></P
188 ></DIV
189 ><DIV
190 CLASS="REFSECT1"
191 ><A
192 NAME="AEN8407"
193 ></A
194 ><H2
195 >Details</H2
196 ><DIV
197 CLASS="REFSECT2"
198 ><A
199 NAME="AEN8409"
200 ></A
201 ><H3
202 ><A
203 NAME="GNOME-VFS-MODULE-INIT-CAPS"
204 ></A
205 >GNOME_VFS_MODULE_INIT</H3
206 ><TABLE
207 BORDER="0"
208 BGCOLOR="#D6E8FF"
209 WIDTH="100%"
210 CELLPADDING="6"
211 ><TR
212 ><TD
213 ><PRE
214 CLASS="PROGRAMLISTING"
215 >#define GNOME_VFS_MODULE_INIT      "vfs_module_init"</PRE
216 ></TD
217 ></TR
218 ></TABLE
219 ><P
220 ></P
221 ></DIV
222 ><HR><DIV
223 CLASS="REFSECT2"
224 ><A
225 NAME="AEN8414"
226 ></A
227 ><H3
228 ><A
229 NAME="GNOME-VFS-MODULE-TRANSFORM-CAPS"
230 ></A
231 >GNOME_VFS_MODULE_TRANSFORM</H3
232 ><TABLE
233 BORDER="0"
234 BGCOLOR="#D6E8FF"
235 WIDTH="100%"
236 CELLPADDING="6"
237 ><TR
238 ><TD
239 ><PRE
240 CLASS="PROGRAMLISTING"
241 >#define GNOME_VFS_MODULE_TRANSFORM "vfs_module_transform"</PRE
242 ></TD
243 ></TR
244 ></TABLE
245 ><P
246 ></P
247 ></DIV
248 ><HR><DIV
249 CLASS="REFSECT2"
250 ><A
251 NAME="AEN8419"
252 ></A
253 ><H3
254 ><A
255 NAME="GNOME-VFS-MODULE-SHUTDOWN-CAPS"
256 ></A
257 >GNOME_VFS_MODULE_SHUTDOWN</H3
258 ><TABLE
259 BORDER="0"
260 BGCOLOR="#D6E8FF"
261 WIDTH="100%"
262 CELLPADDING="6"
263 ><TR
264 ><TD
265 ><PRE
266 CLASS="PROGRAMLISTING"
267 >#define GNOME_VFS_MODULE_SHUTDOWN  "vfs_module_shutdown"</PRE
268 ></TD
269 ></TR
270 ></TABLE
271 ><P
272 ></P
273 ></DIV
274 ><HR><DIV
275 CLASS="REFSECT2"
276 ><A
277 NAME="AEN8424"
278 ></A
279 ><H3
280 ><A
281 NAME="VFS-MODULE-INIT"
282 ></A
283 >vfs_module_init ()</H3
284 ><TABLE
285 BORDER="0"
286 BGCOLOR="#D6E8FF"
287 WIDTH="100%"
288 CELLPADDING="6"
289 ><TR
290 ><TD
291 ><PRE
292 CLASS="PROGRAMLISTING"
293 >GnomeVFSMethod* vfs_module_init             (const char *method_name,
294                                              const char *args);</PRE
295 ></TD
296 ></TR
297 ></TABLE
298 ><P
299 ></P
300 ><DIV
301 CLASS="INFORMALTABLE"
302 ><A
303 NAME="AEN8430"
304 ></A
305 ><P
306 ></P
307 ><TABLE
308 BORDER="0"
309 WIDTH="100%"
310 BGCOLOR="#FFD0D0"
311 CELLSPACING="0"
312 CELLPADDING="4"
313 CLASS="CALSTABLE"
314 ><TBODY
315 ><TR
316 ><TD
317 WIDTH="20%"
318 ALIGN="RIGHT"
319 VALIGN="TOP"
320 ><TT
321 CLASS="PARAMETER"
322 ><I
323 >method_name</I
324 ></TT
325 >&nbsp;:</TD
326 ><TD
327 WIDTH="80%"
328 ALIGN="LEFT"
329 VALIGN="TOP"
330 >&nbsp;</TD
331 ></TR
332 ><TR
333 ><TD
334 WIDTH="20%"
335 ALIGN="RIGHT"
336 VALIGN="TOP"
337 ><TT
338 CLASS="PARAMETER"
339 ><I
340 >args</I
341 ></TT
342 >&nbsp;:</TD
343 ><TD
344 WIDTH="80%"
345 ALIGN="LEFT"
346 VALIGN="TOP"
347 >&nbsp;</TD
348 ></TR
349 ><TR
350 ><TD
351 WIDTH="20%"
352 ALIGN="RIGHT"
353 VALIGN="TOP"
354 ><I
355 CLASS="EMPHASIS"
356 >Returns</I
357 > :</TD
358 ><TD
359 WIDTH="80%"
360 ALIGN="LEFT"
361 VALIGN="TOP"
362 >&nbsp;</TD
363 ></TR
364 ></TBODY
365 ></TABLE
366 ><P
367 ></P
368 ></DIV
369 ></DIV
370 ><HR><DIV
371 CLASS="REFSECT2"
372 ><A
373 NAME="AEN8447"
374 ></A
375 ><H3
376 ><A
377 NAME="VFS-MODULE-TRANSFORM"
378 ></A
379 >vfs_module_transform ()</H3
380 ><TABLE
381 BORDER="0"
382 BGCOLOR="#D6E8FF"
383 WIDTH="100%"
384 CELLPADDING="6"
385 ><TR
386 ><TD
387 ><PRE
388 CLASS="PROGRAMLISTING"
389 >GnomeVFSTransform* vfs_module_transform     (const char *method_name,
390                                              const char *args);</PRE
391 ></TD
392 ></TR
393 ></TABLE
394 ><P
395 ></P
396 ><DIV
397 CLASS="INFORMALTABLE"
398 ><A
399 NAME="AEN8453"
400 ></A
401 ><P
402 ></P
403 ><TABLE
404 BORDER="0"
405 WIDTH="100%"
406 BGCOLOR="#FFD0D0"
407 CELLSPACING="0"
408 CELLPADDING="4"
409 CLASS="CALSTABLE"
410 ><TBODY
411 ><TR
412 ><TD
413 WIDTH="20%"
414 ALIGN="RIGHT"
415 VALIGN="TOP"
416 ><TT
417 CLASS="PARAMETER"
418 ><I
419 >method_name</I
420 ></TT
421 >&nbsp;:</TD
422 ><TD
423 WIDTH="80%"
424 ALIGN="LEFT"
425 VALIGN="TOP"
426 >&nbsp;</TD
427 ></TR
428 ><TR
429 ><TD
430 WIDTH="20%"
431 ALIGN="RIGHT"
432 VALIGN="TOP"
433 ><TT
434 CLASS="PARAMETER"
435 ><I
436 >args</I
437 ></TT
438 >&nbsp;:</TD
439 ><TD
440 WIDTH="80%"
441 ALIGN="LEFT"
442 VALIGN="TOP"
443 >&nbsp;</TD
444 ></TR
445 ><TR
446 ><TD
447 WIDTH="20%"
448 ALIGN="RIGHT"
449 VALIGN="TOP"
450 ><I
451 CLASS="EMPHASIS"
452 >Returns</I
453 > :</TD
454 ><TD
455 WIDTH="80%"
456 ALIGN="LEFT"
457 VALIGN="TOP"
458 >&nbsp;</TD
459 ></TR
460 ></TBODY
461 ></TABLE
462 ><P
463 ></P
464 ></DIV
465 ></DIV
466 ><HR><DIV
467 CLASS="REFSECT2"
468 ><A
469 NAME="AEN8470"
470 ></A
471 ><H3
472 ><A
473 NAME="VFS-MODULE-SHUTDOWN"
474 ></A
475 >vfs_module_shutdown ()</H3
476 ><TABLE
477 BORDER="0"
478 BGCOLOR="#D6E8FF"
479 WIDTH="100%"
480 CELLPADDING="6"
481 ><TR
482 ><TD
483 ><PRE
484 CLASS="PROGRAMLISTING"
485 >void        vfs_module_shutdown             (GnomeVFSMethod *method);</PRE
486 ></TD
487 ></TR
488 ></TABLE
489 ><P
490 ></P
491 ><DIV
492 CLASS="INFORMALTABLE"
493 ><A
494 NAME="AEN8476"
495 ></A
496 ><P
497 ></P
498 ><TABLE
499 BORDER="0"
500 WIDTH="100%"
501 BGCOLOR="#FFD0D0"
502 CELLSPACING="0"
503 CELLPADDING="4"
504 CLASS="CALSTABLE"
505 ><TBODY
506 ><TR
507 ><TD
508 WIDTH="20%"
509 ALIGN="RIGHT"
510 VALIGN="TOP"
511 ><TT
512 CLASS="PARAMETER"
513 ><I
514 >method</I
515 ></TT
516 >&nbsp;:</TD
517 ><TD
518 WIDTH="80%"
519 ALIGN="LEFT"
520 VALIGN="TOP"
521 >&nbsp;</TD
522 ></TR
523 ></TBODY
524 ></TABLE
525 ><P
526 ></P
527 ></DIV
528 ></DIV
529 ></DIV
530 ><DIV
531 CLASS="NAVFOOTER"
532 ><BR
533 CLEAR="all"><BR><TABLE
534 WIDTH="100%"
535 BORDER="0"
536 BGCOLOR="#000000"
537 CELLPADDING="1"
538 CELLSPACING="0"
539 ><TR
540 ><TD
541 WIDTH="25%"
542 BGCOLOR="#C00000"
543 ALIGN="left"
544 ><A
545 HREF="gnome-vfs-module-shared.html"
546 ><FONT
547 COLOR="#FFFFFF"
548 SIZE="3"
549 ><B
550 >&#60;&#60;&#60; Previous Page</B
551 ></FONT
552 ></A
553 ></TD
554 ><TD
555 WIDTH="25%"
556 BGCOLOR="#0000C0"
557 ALIGN="center"
558 ><FONT
559 COLOR="#FFFFFF"
560 SIZE="3"
561 ><B
562 ><A
563 HREF="index.html"
564 ><FONT
565 COLOR="#FFFFFF"
566 SIZE="3"
567 ><B
568 >Home</B
569 ></FONT
570 ></A
571 ></B
572 ></FONT
573 ></TD
574 ><TD
575 WIDTH="25%"
576 BGCOLOR="#00C000"
577 ALIGN="center"
578 ><FONT
579 COLOR="#FFFFFF"
580 SIZE="3"
581 ><B
582 ><A
583 HREF="modules.html"
584 ><FONT
585 COLOR="#FFFFFF"
586 SIZE="3"
587 ><B
588 >Up</B
589 ></FONT
590 ></A
591 ></B
592 ></FONT
593 ></TD
594 ><TD
595 WIDTH="25%"
596 BGCOLOR="#C00000"
597 ALIGN="right"
598 ><A
599 HREF="gnome-vfs-module-callback-module-api.html"
600 ><FONT
601 COLOR="#FFFFFF"
602 SIZE="3"
603 ><B
604 >Next Page &#62;&#62;&#62;</B
605 ></FONT
606 ></A
607 ></TD
608 ></TR
609 ><TR
610 ><TD
611 COLSPAN="2"
612 ALIGN="left"
613 ><FONT
614 COLOR="#FFFFFF"
615 SIZE="3"
616 ><B
617 >module-shared</B
618 ></FONT
619 ></TD
620 ><TD
621 COLSPAN="2"
622 ALIGN="right"
623 ><FONT
624 COLOR="#FFFFFF"
625 SIZE="3"
626 ><B
627 >Module Callbacks (Module API)</B
628 ></FONT
629 ></TD
630 ></TR
631 ></TABLE
632 ></DIV
633 ></BODY
634 ></HTML
635 >