ftp://ftp.redhat.com/pub/redhat/linux/rawhide/SRPMS/SRPMS/gnome-vfs2-2.3.8-1.src.rpm
[gnome-vfs-httpcaptive.git] / doc / html / gnome-vfs-gnome-vfs-module-shared.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gnome-vfs-module-shared</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-gnome-vfs-module.html" title="gnome-vfs-module"><link rel="next" href="gnome-vfs-gnome-vfs-module-callback-module-api.html" title="gnome-vfs-module-callback-module-api"></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-gnome-vfs-module.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-gnome-vfs-module-callback-module-api.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-gnome-vfs-module-shared"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">gnome-vfs-module-shared</span></h2><p>gnome-vfs-module-shared &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
32
33
34
35 const <a
36 href="../glib/glib-Basic-Types.html#gchar"
37 >gchar</a>* <a href="gnome-vfs-gnome-vfs-module-shared.html#gnome-vfs-mime-type-from-mode">gnome_vfs_mime_type_from_mode</a>  (mode_t mode);
38 void        <a href="gnome-vfs-gnome-vfs-module-shared.html#gnome-vfs-stat-to-file-info">gnome_vfs_stat_to_file_info</a>     (<a href="gnome-vfs-gnome-vfs-file-info.html#GnomeVFSFileInfo">GnomeVFSFileInfo</a> *file_info,
39                                              const struct stat *statptr);
40 <a href="gnome-vfs-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-gnome-vfs-module-shared.html#gnome-vfs-set-meta">gnome_vfs_set_meta</a>           (<a href="gnome-vfs-gnome-vfs-file-info.html#GnomeVFSFileInfo">GnomeVFSFileInfo</a> *info,
41                                              const char *file_name,
42                                              const char *meta_key);
43 <a href="gnome-vfs-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-gnome-vfs-module-shared.html#gnome-vfs-set-meta-for-list">gnome_vfs_set_meta_for_list</a>  (<a href="gnome-vfs-gnome-vfs-file-info.html#GnomeVFSFileInfo">GnomeVFSFileInfo</a> *info,
44                                              const char *file_name,
45                                              const <a
46 href="../glib/glib-Doubly-Linked-Lists.html#GList"
47 >GList</a> *meta_keys);
48 const char* <a href="gnome-vfs-gnome-vfs-module-shared.html#gnome-vfs-get-special-mime-type">gnome_vfs_get_special_mime_type</a> (GnomeVFSURI *uri);
49 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
50
51 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="gnome-vfs-mime-type-from-mode"></a>gnome_vfs_mime_type_from_mode ()</h3><pre class="programlisting">const <a
52 href="../glib/glib-Basic-Types.html#gchar"
53 >gchar</a>* gnome_vfs_mime_type_from_mode  (mode_t mode);</pre><p>
54 Returns a MIME type based on the mode passed. It only works when mode
55 references a special file (directory, device, fifo, socket or symlink)
56 </p><p>
57 Returns: a string containing the MIME type, if <i class="parameter"><tt>mode</tt></i> is a normal file</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>mode</tt></i> :</span></td><td>
60 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>NULL.
61 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-stat-to-file-info"></a>gnome_vfs_stat_to_file_info ()</h3><pre class="programlisting">void        gnome_vfs_stat_to_file_info     (<a href="gnome-vfs-gnome-vfs-file-info.html#GnomeVFSFileInfo">GnomeVFSFileInfo</a> *file_info,
62                                              const struct stat *statptr);</pre><p>
63
64 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>file_info</tt></i> :</span></td><td>
65 </td></tr><tr><td><span class="term"><i class="parameter"><tt>statptr</tt></i> :</span></td><td>
66
67
68 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-set-meta"></a>gnome_vfs_set_meta ()</h3><pre class="programlisting"><a href="gnome-vfs-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_set_meta           (<a href="gnome-vfs-gnome-vfs-file-info.html#GnomeVFSFileInfo">GnomeVFSFileInfo</a> *info,
69                                              const char *file_name,
70                                              const char *meta_key);</pre><p>
71
72 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>info</tt></i> :</span></td><td>
73 </td></tr><tr><td><span class="term"><i class="parameter"><tt>file_name</tt></i> :</span></td><td>
74 </td></tr><tr><td><span class="term"><i class="parameter"><tt>meta_key</tt></i> :</span></td><td>
75 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
76
77
78 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-set-meta-for-list"></a>gnome_vfs_set_meta_for_list ()</h3><pre class="programlisting"><a href="gnome-vfs-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_set_meta_for_list  (<a href="gnome-vfs-gnome-vfs-file-info.html#GnomeVFSFileInfo">GnomeVFSFileInfo</a> *info,
79                                              const char *file_name,
80                                              const <a
81 href="../glib/glib-Doubly-Linked-Lists.html#GList"
82 >GList</a> *meta_keys);</pre><p>
83
84 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>info</tt></i> :</span></td><td>
85 </td></tr><tr><td><span class="term"><i class="parameter"><tt>file_name</tt></i> :</span></td><td>
86 </td></tr><tr><td><span class="term"><i class="parameter"><tt>meta_keys</tt></i> :</span></td><td>
87 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
88
89
90 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-get-special-mime-type"></a>gnome_vfs_get_special_mime_type ()</h3><pre class="programlisting">const char* gnome_vfs_get_special_mime_type (GnomeVFSURI *uri);</pre><p>
91 Gets the MIME type for <i class="parameter"><tt>uri</tt></i>, this function only returns the type
92 when the URI points to a file that can't be sniffed (sockets, 
93 directories, devices, and fifos).</p><p>
94
95 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>uri</tt></i> :</span></td><td>
96 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a string containing the mime type, NULL if the <i class="parameter"><tt>uri</tt></i> doesn't 
97 present an special file.
98 </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-gnome-vfs-module.html"><b>&lt;&lt; gnome-vfs-module</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-gnome-vfs-module-callback-module-api.html"><b>gnome-vfs-module-callback-module-api &gt;&gt;</b></a></td></tr></table></body></html>