doc/html/gnome-vfs-20-gnome-vfs-module.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gnome-vfs-module</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-method.html" title="gnome-vfs-method"><link rel="next" href="gnome-vfs-20-gnome-vfs-module-shared.html" title="gnome-vfs-module-shared"></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-method.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-shared.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-module"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">gnome-vfs-module</span></h2><p>gnome-vfs-module &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  32
  33
  34
  35 GnomeVFSMethod* <a href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-init">vfs_module_init</a>             (const char *method_name,
  36                                              const char *args);
  37 GnomeVFSTransform* <a href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-transform">vfs_module_transform</a>     (const char *method_name,
  38                                              const char *args);
  39 void        <a href="gnome-vfs-20-gnome-vfs-module.html#vfs-module-shutdown">vfs_module_shutdown</a>             (GnomeVFSMethod *method);
  40 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  41
  42 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="vfs-module-init"></a>vfs_module_init ()</h3><a class="indexterm" name="id2978090"></a><pre class="programlisting">GnomeVFSMethod* vfs_module_init             (const char *method_name,
  43                                              const char *args);</pre><p>
  44 Standard extern call implemented by each filesystem module. This is called
  45 to initialize the module and setup any basic structures / connections the
  46 method requires. It also allows the module to identify the URI method it is
  47 associated with in this instance.</p><p>
  48
  49 </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> name of the method that invoked this module (e.g. "http", "ftp", "file").
  50 </td></tr><tr><td><span class="term"><i class="parameter"><tt>args</tt></i> :</span></td><td> not used by most modules, but potential arguments for creating the module (could
  51 be a file to point at, for example)
  52 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the module symbol table, pointing to the appropriate calls for
  53 this module.
  54 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="vfs-module-transform"></a>vfs_module_transform ()</h3><a class="indexterm" name="id2978211"></a><pre class="programlisting">GnomeVFSTransform* vfs_module_transform     (const char *method_name,
  55                                              const char *args);</pre><p>
  56 Shift an already instanced module to a new method name. This call is not implemented
  57 by most modules and is optional.</p><p>
  58
  59 </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> name of the method that invoked this module (e.g. "http", "ftp", "file").
  60 </td></tr><tr><td><span class="term"><i class="parameter"><tt>args</tt></i> :</span></td><td> not used by most modules, but potential arguments for creating the module (could
  61 be a file to point at, for example)
  62 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the module symbol table, pointing to the appropriate calls for
  63 this module.
  64 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="vfs-module-shutdown"></a>vfs_module_shutdown ()</h3><a class="indexterm" name="id2978328"></a><pre class="programlisting">void        vfs_module_shutdown             (GnomeVFSMethod *method);</pre><p>
  65 Called to tell a module to end any active operations, free all used memory,
  66 and close any connections (as appropriate) or resources.</p><p>
  67
  68 </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> the symbol table of the module being shut down
  69 </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-method.html"><b>&lt;&lt; gnome-vfs-method</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-20-gnome-vfs-module-shared.html"><b>gnome-vfs-module-shared &gt;&gt;</b></a></td></tr></table></body></html>