doc/xml/gnome-vfs-init.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-init">
   2 <refmeta>
   3 <refentrytitle>Initialization/Shutdown</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>Initialization/Shutdown</refname><refpurpose></refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  18 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-init">gnome_vfs_init</link>                  (void);
  19 <link linkend="gboolean">gboolean</link>    <link linkend="gnome-vfs-initialized">gnome_vfs_initialized</link>           (void);
  20 <link linkend="void">void</link>        <link linkend="gnome-vfs-shutdown">gnome_vfs_shutdown</link>              (void);
  21 <link linkend="void">void</link>        <link linkend="gnome-vfs-loadinit">gnome_vfs_loadinit</link>              (<link linkend="gpointer">gpointer</link> app,
  22                                              <link linkend="gpointer">gpointer</link> modinfo);
  23 <link linkend="void">void</link>        <link linkend="gnome-vfs-preinit">gnome_vfs_preinit</link>               (<link linkend="gpointer">gpointer</link> app,
  24                                              <link linkend="gpointer">gpointer</link> modinfo);
  25 <link linkend="void">void</link>        <link linkend="gnome-vfs-postinit">gnome_vfs_postinit</link>              (<link linkend="gpointer">gpointer</link> app,
  26                                              <link linkend="gpointer">gpointer</link> modinfo);
  27 </synopsis>
  28 </refsynopsisdiv>
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38 <refsect1>
  39 <title>Description</title>
  40 <para>
  41 Starting GnomeVFS up and shutting it down. Usually when using the whole
  42 GNOME framework this library is initialized and shutdown automatically
  43 when calling gnome_init.
  44 </para>
  45 </refsect1>
  46
  47 <refsect1>
  48 <title>Details</title>
  49 <refsect2>
  50 <title><anchor id="gnome-vfs-init"/>gnome_vfs_init ()</title>
  51 <indexterm><primary>gnome_vfs_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_init                  (void);</programlisting>
  52 <para>
  53 If GnomeVFS is not already initialized, initialize it. This must be
  54 called prior to performing any other GnomeVFS operations, and may
  55 be called multiple times without error.</para>
  56 <para>
  57
  58 </para><variablelist role="params">
  59 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if GnomeVFS is successfully initialized (or was
  60 already initialized)
  61 </simpara></listitem></varlistentry>
  62 </variablelist></refsect2>
  63 <refsect2>
  64 <title><anchor id="gnome-vfs-initialized"/>gnome_vfs_initialized ()</title>
  65 <indexterm><primary>gnome_vfs_initialized</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_vfs_initialized           (void);</programlisting>
  66 <para>
  67 Detects if GnomeVFS has already been initialized (GnomeVFS must be
  68 initialized prior to using any methods or operations).</para>
  69 <para>
  70
  71 </para><variablelist role="params">
  72 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if GnomeVFS has already been initialized
  73 </simpara></listitem></varlistentry>
  74 </variablelist></refsect2>
  75 <refsect2>
  76 <title><anchor id="gnome-vfs-shutdown"/>gnome_vfs_shutdown ()</title>
  77 <indexterm><primary>gnome_vfs_shutdown</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_shutdown              (void);</programlisting>
  78 <para>
  79 Cease all active GnomeVFS operations and unload the MIME
  80 database from memory.</para>
  81 <para>
  82
  83 </para></refsect2>
  84 <refsect2>
  85 <title><anchor id="gnome-vfs-loadinit"/>gnome_vfs_loadinit ()</title>
  86 <indexterm><primary>gnome_vfs_loadinit</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_loadinit              (<link linkend="gpointer">gpointer</link> app,
  87                                              <link linkend="gpointer">gpointer</link> modinfo);</programlisting>
  88 <para>
  89
  90 </para><variablelist role="params">
  91 <varlistentry><term><parameter>app</parameter>&nbsp;:</term>
  92 <listitem><simpara>
  93 </simpara></listitem></varlistentry>
  94 <varlistentry><term><parameter>modinfo</parameter>&nbsp;:</term>
  95 <listitem><simpara>
  96
  97
  98 </simpara></listitem></varlistentry>
  99 </variablelist></refsect2>
 100 <refsect2>
 101 <title><anchor id="gnome-vfs-preinit"/>gnome_vfs_preinit ()</title>
 102 <indexterm><primary>gnome_vfs_preinit</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_preinit               (<link linkend="gpointer">gpointer</link> app,
 103                                              <link linkend="gpointer">gpointer</link> modinfo);</programlisting>
 104 <para>
 105
 106 </para><variablelist role="params">
 107 <varlistentry><term><parameter>app</parameter>&nbsp;:</term>
 108 <listitem><simpara>
 109 </simpara></listitem></varlistentry>
 110 <varlistentry><term><parameter>modinfo</parameter>&nbsp;:</term>
 111 <listitem><simpara>
 112
 113
 114 </simpara></listitem></varlistentry>
 115 </variablelist></refsect2>
 116 <refsect2>
 117 <title><anchor id="gnome-vfs-postinit"/>gnome_vfs_postinit ()</title>
 118 <indexterm><primary>gnome_vfs_postinit</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_postinit              (<link linkend="gpointer">gpointer</link> app,
 119                                              <link linkend="gpointer">gpointer</link> modinfo);</programlisting>
 120 <para>
 121
 122 </para><variablelist role="params">
 123 <varlistentry><term><parameter>app</parameter>&nbsp;:</term>
 124 <listitem><simpara>
 125 </simpara></listitem></varlistentry>
 126 <varlistentry><term><parameter>modinfo</parameter>&nbsp;:</term>
 127 <listitem><simpara>
 128
 129
 130 </simpara></listitem></varlistentry>
 131 </variablelist></refsect2>
 132
 133 </refsect1>
 134
 135
 136
 137
 138 </refentry>