doc/xml/gnome-vfs-module-shared.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-module-shared">
   2 <refmeta>
   3 <refentrytitle>gnome-vfs-module-shared</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   9 <refname>gnome-vfs-module-shared</refname><refpurpose></refpurpose>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  18 const <link linkend="gchar">gchar</link>* <link linkend="gnome-vfs-mime-type-from-mode">gnome_vfs_mime_type_from_mode</link>  (<link linkend="mode-t">mode_t</link> mode);
  19 <link linkend="void">void</link>        <link linkend="gnome-vfs-stat-to-file-info">gnome_vfs_stat_to_file_info</link>     (<link linkend="GnomeVFSFileInfo">GnomeVFSFileInfo</link> *file_info,
  20                                              const struct <link linkend="stat">stat</link> *statptr);
  21 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-set-meta">gnome_vfs_set_meta</link>           (<link linkend="GnomeVFSFileInfo">GnomeVFSFileInfo</link> *info,
  22                                              const <link linkend="char">char</link> *file_name,
  23                                              const <link linkend="char">char</link> *meta_key);
  24 <link linkend="GnomeVFSResult">GnomeVFSResult</link> <link linkend="gnome-vfs-set-meta-for-list">gnome_vfs_set_meta_for_list</link>  (<link linkend="GnomeVFSFileInfo">GnomeVFSFileInfo</link> *info,
  25                                              const <link linkend="char">char</link> *file_name,
  26                                              const <link linkend="GList">GList</link> *meta_keys);
  27 const <link linkend="char">char</link>* <link linkend="gnome-vfs-get-special-mime-type">gnome_vfs_get_special_mime_type</link> (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);
  28 </synopsis>
  29 </refsynopsisdiv>
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39 <refsect1>
  40 <title>Description</title>
  41 <para>
  42
  43 </para>
  44 </refsect1>
  45
  46 <refsect1>
  47 <title>Details</title>
  48 <refsect2>
  49 <title><anchor id="gnome-vfs-mime-type-from-mode"/>gnome_vfs_mime_type_from_mode ()</title>
  50 <indexterm><primary>gnome_vfs_mime_type_from_mode</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_vfs_mime_type_from_mode  (<link linkend="mode-t">mode_t</link> mode);</programlisting>
  51 <para>
  52 Returns a MIME type based on the mode passed. It only works when mode
  53 references a special file (directory, device, fifo, socket or symlink)
  54 </para>
  55 <para>
  56 Returns: a string containing the MIME type, if <parameter>mode</parameter> is a normal file</para>
  57 <para>
  58
  59 </para><variablelist role="params">
  60 <varlistentry><term><parameter>mode</parameter>&nbsp;:</term>
  61 <listitem><simpara>
  62 </simpara></listitem></varlistentry>
  63 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>NULL.
  64 </simpara></listitem></varlistentry>
  65 </variablelist></refsect2>
  66 <refsect2>
  67 <title><anchor id="gnome-vfs-stat-to-file-info"/>gnome_vfs_stat_to_file_info ()</title>
  68 <indexterm><primary>gnome_vfs_stat_to_file_info</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_vfs_stat_to_file_info     (<link linkend="GnomeVFSFileInfo">GnomeVFSFileInfo</link> *file_info,
  69                                              const struct <link linkend="stat">stat</link> *statptr);</programlisting>
  70 <para>
  71
  72 </para><variablelist role="params">
  73 <varlistentry><term><parameter>file_info</parameter>&nbsp;:</term>
  74 <listitem><simpara>
  75 </simpara></listitem></varlistentry>
  76 <varlistentry><term><parameter>statptr</parameter>&nbsp;:</term>
  77 <listitem><simpara>
  78
  79
  80 </simpara></listitem></varlistentry>
  81 </variablelist></refsect2>
  82 <refsect2>
  83 <title><anchor id="gnome-vfs-set-meta"/>gnome_vfs_set_meta ()</title>
  84 <indexterm><primary>gnome_vfs_set_meta</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_set_meta           (<link linkend="GnomeVFSFileInfo">GnomeVFSFileInfo</link> *info,
  85                                              const <link linkend="char">char</link> *file_name,
  86                                              const <link linkend="char">char</link> *meta_key);</programlisting>
  87 <para>
  88
  89 </para><variablelist role="params">
  90 <varlistentry><term><parameter>info</parameter>&nbsp;:</term>
  91 <listitem><simpara>
  92 </simpara></listitem></varlistentry>
  93 <varlistentry><term><parameter>file_name</parameter>&nbsp;:</term>
  94 <listitem><simpara>
  95 </simpara></listitem></varlistentry>
  96 <varlistentry><term><parameter>meta_key</parameter>&nbsp;:</term>
  97 <listitem><simpara>
  98 </simpara></listitem></varlistentry>
  99 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 100
 101
 102 </simpara></listitem></varlistentry>
 103 </variablelist></refsect2>
 104 <refsect2>
 105 <title><anchor id="gnome-vfs-set-meta-for-list"/>gnome_vfs_set_meta_for_list ()</title>
 106 <indexterm><primary>gnome_vfs_set_meta_for_list</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link> gnome_vfs_set_meta_for_list  (<link linkend="GnomeVFSFileInfo">GnomeVFSFileInfo</link> *info,
 107                                              const <link linkend="char">char</link> *file_name,
 108                                              const <link linkend="GList">GList</link> *meta_keys);</programlisting>
 109 <para>
 110
 111 </para><variablelist role="params">
 112 <varlistentry><term><parameter>info</parameter>&nbsp;:</term>
 113 <listitem><simpara>
 114 </simpara></listitem></varlistentry>
 115 <varlistentry><term><parameter>file_name</parameter>&nbsp;:</term>
 116 <listitem><simpara>
 117 </simpara></listitem></varlistentry>
 118 <varlistentry><term><parameter>meta_keys</parameter>&nbsp;:</term>
 119 <listitem><simpara>
 120 </simpara></listitem></varlistentry>
 121 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 122
 123
 124 </simpara></listitem></varlistentry>
 125 </variablelist></refsect2>
 126 <refsect2>
 127 <title><anchor id="gnome-vfs-get-special-mime-type"/>gnome_vfs_get_special_mime_type ()</title>
 128 <indexterm><primary>gnome_vfs_get_special_mime_type</primary></indexterm><programlisting>const <link linkend="char">char</link>* gnome_vfs_get_special_mime_type (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 129 <para>
 130 Gets the MIME type for <parameter>uri</parameter>, this function only returns the type
 131 when the URI points to a file that can't be sniffed (sockets,
 132 directories, devices, and fifos).</para>
 133 <para>
 134
 135 </para><variablelist role="params">
 136 <varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 137 <listitem><simpara>
 138 </simpara></listitem></varlistentry>
 139 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string containing the mime type, NULL if the <parameter>uri</parameter> doesn't
 140 present an special file.
 141 </simpara></listitem></varlistentry>
 142 </variablelist></refsect2>
 143
 144 </refsect1>
 145
 146
 147
 148
 149 </refentry>