## gnome-vfs-module

gnome-vfs-module

## Synopsis

    GnomeVFSMethod *    vfs_module_init                     (const char *method_name,
                                                             const char *args);
    GnomeVFSTransform * vfs_module_transform                (const char *method_name,
                                                             const char *args);
    void                vfs_module_shutdown                 (GnomeVFSMethod *method);

## Description

## Details

### vfs_module_init ()

    GnomeVFSMethod *    vfs_module_init                     (const char *method_name,
                                                             const char *args);

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.

`method_name` : | name of the method that invoked this module (e.g. "http", "ftp", "file").
`args` : | not used by most modules, but potential arguments for creating the module (could be a file to point at, for example)
Returns : | the module symbol table, pointing to the appropriate calls for this module.

### vfs_module_transform ()

    GnomeVFSTransform * vfs_module_transform                (const char *method_name,
                                                             const char *args);

Shift an already instanced module to a new method name. This call is not implemented by most modules and is optional.

`method_name` : | name of the method that invoked this module (e.g. "http", "ftp", "file").
`args` : | not used by most modules, but potential arguments for creating the module (could be a file to point at, for example)
Returns : | the module symbol table, pointing to the appropriate calls for this module.

### vfs_module_shutdown ()

    void                vfs_module_shutdown                 (GnomeVFSMethod *method);

Called to tell a module to end any active operations, free all used memory, and close any connections (as appropriate) or resources.

`method` : | the symbol table of the module being shut down