<refentry id="gnome-vfs-20-gnome-vfs-module">
<refmeta>
<refentrytitle id="top_of_page">gnome-vfs-module</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gnome-vfs-module</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>

<synopsis>



<link linkend="GnomeVFSMethod">GnomeVFSMethod</link>* <link linkend="vfs-module-init">vfs_module_init</link>             (const <link linkend="char">char</link> *method_name,
                                             const <link linkend="char">char</link> *args);
<link linkend="GnomeVFSTransform">GnomeVFSTransform</link>* <link linkend="vfs-module-transform">vfs_module_transform</link>     (const <link linkend="char">char</link> *method_name,
                                             const <link linkend="char">char</link> *args);
<link linkend="void">void</link>        <link linkend="vfs-module-shutdown">vfs_module_shutdown</link>             (<link linkend="GnomeVFSMethod">GnomeVFSMethod</link> *method);
</synopsis>
</refsynopsisdiv>









<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="vfs-module-init" role="function"/>vfs_module_init ()</title>
<indexterm><primary>vfs_module_init</primary></indexterm><programlisting><link linkend="GnomeVFSMethod">GnomeVFSMethod</link>* vfs_module_init             (const <link linkend="char">char</link> *method_name,
                                             const <link linkend="char">char</link> *args);</programlisting>
<para>
Standard extern call implemented by each filesystem module. This is called
to initialize the module and setup any basic structures / connections the
method requires. It also allows the module to identify the URI method it is
associated with in this instance.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>method_name</parameter>&nbsp;:</term>
<listitem><simpara> name of the method that invoked this module (e.g. "http", "ftp", "file").
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
<listitem><simpara> not used by most modules, but potential arguments for creating the module (could
be a file to point at, for example)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the module symbol table, pointing to the appropriate calls for
this module.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="vfs-module-transform" role="function"/>vfs_module_transform ()</title>
<indexterm><primary>vfs_module_transform</primary></indexterm><programlisting><link linkend="GnomeVFSTransform">GnomeVFSTransform</link>* vfs_module_transform     (const <link linkend="char">char</link> *method_name,
                                             const <link linkend="char">char</link> *args);</programlisting>
<para>
Shift an already instanced module to a new method name. This call is not implemented
by most modules and is optional.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>method_name</parameter>&nbsp;:</term>
<listitem><simpara> name of the method that invoked this module (e.g. "http", "ftp", "file").
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
<listitem><simpara> not used by most modules, but potential arguments for creating the module (could
be a file to point at, for example)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the module symbol table, pointing to the appropriate calls for
this module.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="vfs-module-shutdown" role="function"/>vfs_module_shutdown ()</title>
<indexterm><primary>vfs_module_shutdown</primary></indexterm><programlisting><link linkend="void">void</link>        vfs_module_shutdown             (<link linkend="GnomeVFSMethod">GnomeVFSMethod</link> *method);</programlisting>
<para>
Called to tell a module to end any active operations, free all used memory,
and close any connections (as appropriate) or resources.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>method</parameter>&nbsp;:</term>
<listitem><simpara> the symbol table of the module being shut down
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
