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-20-gnome-vfs-uri.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GnomeVFSURI</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="data-types.html" title="Data Types"><link rel="previous" href="gnome-vfs-20-gnome-vfs-result.html" title="GnomeVFSResult"><link rel="next" href="mime-registry.html" title="MIME Registry"></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-20-gnome-vfs-result.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="data-types.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="mime-registry.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-20-gnome-vfs-uri"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">GnomeVFSURI</span></h2><p>GnomeVFSURI &#8212; 
32 Functions for manipulating URIs</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
33
34
35
36 typedef     <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSToplevelURI">GnomeVFSToplevelURI</a>;
37 enum        <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURIHideOptions">GnomeVFSURIHideOptions</a>;
38 #define     <a href="gnome-vfs-20-gnome-vfs-uri.html#GNOME-VFS-URI-MAGIC-CHR-CAPS">GNOME_VFS_URI_MAGIC_CHR</a>
39 #define     <a href="gnome-vfs-20-gnome-vfs-uri.html#GNOME-VFS-URI-MAGIC-STR-CAPS">GNOME_VFS_URI_MAGIC_STR</a>
40 #define     <a href="gnome-vfs-20-gnome-vfs-uri.html#GNOME-VFS-URI-PATH-CHR-CAPS">GNOME_VFS_URI_PATH_CHR</a>
41 #define     <a href="gnome-vfs-20-gnome-vfs-uri.html#GNOME-VFS-URI-PATH-STR-CAPS">GNOME_VFS_URI_PATH_STR</a>
42 GnomeVFSURI* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-new">gnome_vfs_uri_new</a>              (const <a
43 href="../glib/glib-Basic-Types.html#gchar"
44 >gchar</a> *text_uri);
45 GnomeVFSURI* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-resolve-relative">gnome_vfs_uri_resolve_relative</a> (const GnomeVFSURI *base,
46                                              const <a
47 href="../glib/glib-Basic-Types.html#gchar"
48 >gchar</a> *relative_reference);
49 GnomeVFSURI* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-ref">gnome_vfs_uri_ref</a>              (GnomeVFSURI *uri);
50 void        <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-unref">gnome_vfs_uri_unref</a>             (GnomeVFSURI *uri);
51 GnomeVFSURI* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-append-string">gnome_vfs_uri_append_string</a>    (const GnomeVFSURI *uri,
52                                              const char *uri_fragment);
53 GnomeVFSURI* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-append-path">gnome_vfs_uri_append_path</a>      (const GnomeVFSURI *uri,
54                                              const char *path);
55 GnomeVFSURI* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-append-file-name">gnome_vfs_uri_append_file_name</a> (const GnomeVFSURI *uri,
56                                              const <a
57 href="../glib/glib-Basic-Types.html#gchar"
58 >gchar</a> *filename);
59 <a
60 href="../glib/glib-Basic-Types.html#gchar"
61 >gchar</a>*      <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-to-string">gnome_vfs_uri_to_string</a>         (const GnomeVFSURI *uri,
62                                              <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURIHideOptions">GnomeVFSURIHideOptions</a> hide_options);
63 GnomeVFSURI* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-dup">gnome_vfs_uri_dup</a>              (const GnomeVFSURI *uri);
64 <a
65 href="../glib/glib-Basic-Types.html#gboolean"
66 >gboolean</a>    <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-is-local">gnome_vfs_uri_is_local</a>          (const GnomeVFSURI *uri);
67 <a
68 href="../glib/glib-Basic-Types.html#gboolean"
69 >gboolean</a>    <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-has-parent">gnome_vfs_uri_has_parent</a>        (const GnomeVFSURI *uri);
70 GnomeVFSURI* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-parent">gnome_vfs_uri_get_parent</a>       (const GnomeVFSURI *uri);
71 <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSToplevelURI">GnomeVFSToplevelURI</a>* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-toplevel">gnome_vfs_uri_get_toplevel</a>
72                                             (const GnomeVFSURI *uri);
73 const <a
74 href="../glib/glib-Basic-Types.html#gchar"
75 >gchar</a>* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-host-name">gnome_vfs_uri_get_host_name</a>    (const GnomeVFSURI *uri);
76 const <a
77 href="../glib/glib-Basic-Types.html#gchar"
78 >gchar</a>* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-scheme">gnome_vfs_uri_get_scheme</a>       (const GnomeVFSURI *uri);
79 <a
80 href="../glib/glib-Basic-Types.html#guint"
81 >guint</a>       <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-host-port">gnome_vfs_uri_get_host_port</a>     (const GnomeVFSURI *uri);
82 const <a
83 href="../glib/glib-Basic-Types.html#gchar"
84 >gchar</a>* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-user-name">gnome_vfs_uri_get_user_name</a>    (const GnomeVFSURI *uri);
85 const <a
86 href="../glib/glib-Basic-Types.html#gchar"
87 >gchar</a>* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-password">gnome_vfs_uri_get_password</a>     (const GnomeVFSURI *uri);
88 void        <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-set-host-name">gnome_vfs_uri_set_host_name</a>     (GnomeVFSURI *uri,
89                                              const <a
90 href="../glib/glib-Basic-Types.html#gchar"
91 >gchar</a> *host_name);
92 void        <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-set-host-port">gnome_vfs_uri_set_host_port</a>     (GnomeVFSURI *uri,
93                                              <a
94 href="../glib/glib-Basic-Types.html#guint"
95 >guint</a> host_port);
96 void        <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-set-user-name">gnome_vfs_uri_set_user_name</a>     (GnomeVFSURI *uri,
97                                              const <a
98 href="../glib/glib-Basic-Types.html#gchar"
99 >gchar</a> *user_name);
100 void        <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-set-password">gnome_vfs_uri_set_password</a>      (GnomeVFSURI *uri,
101                                              const <a
102 href="../glib/glib-Basic-Types.html#gchar"
103 >gchar</a> *password);
104 <a
105 href="../glib/glib-Basic-Types.html#gboolean"
106 >gboolean</a>    <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-equal">gnome_vfs_uri_equal</a>             (const GnomeVFSURI *a,
107                                              const GnomeVFSURI *b);
108 <a
109 href="../glib/glib-Basic-Types.html#gboolean"
110 >gboolean</a>    <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-is-parent">gnome_vfs_uri_is_parent</a>         (const GnomeVFSURI *possible_parent,
111                                              const GnomeVFSURI *possible_child,
112                                              <a
113 href="../glib/glib-Basic-Types.html#gboolean"
114 >gboolean</a> recursive);
115 const <a
116 href="../glib/glib-Basic-Types.html#gchar"
117 >gchar</a>* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-path">gnome_vfs_uri_get_path</a>         (const GnomeVFSURI *uri);
118 const <a
119 href="../glib/glib-Basic-Types.html#gchar"
120 >gchar</a>* <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-get-fragment-identifier">gnome_vfs_uri_get_fragment_identifier</a>
121                                             (const GnomeVFSURI *uri);
122 <a
123 href="../glib/glib-Basic-Types.html#gchar"
124 >gchar</a>*      <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-extract-dirname">gnome_vfs_uri_extract_dirname</a>   (const GnomeVFSURI *uri);
125 <a
126 href="../glib/glib-Basic-Types.html#gchar"
127 >gchar</a>*      <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-extract-short-name">gnome_vfs_uri_extract_short_name</a>
128                                             (const GnomeVFSURI *uri);
129 <a
130 href="../glib/glib-Basic-Types.html#gchar"
131 >gchar</a>*      <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-extract-short-path-name">gnome_vfs_uri_extract_short_path_name</a>
132                                             (const GnomeVFSURI *uri);
133 <a
134 href="../glib/glib-Basic-Types.html#gint"
135 >gint</a>        <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-hequal">gnome_vfs_uri_hequal</a>            (<a
136 href="../glib/glib-Basic-Types.html#gconstpointer"
137 >gconstpointer</a> a,
138                                              <a
139 href="../glib/glib-Basic-Types.html#gconstpointer"
140 >gconstpointer</a> b);
141 <a
142 href="../glib/glib-Basic-Types.html#guint"
143 >guint</a>       <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-hash">gnome_vfs_uri_hash</a>              (<a
144 href="../glib/glib-Basic-Types.html#gconstpointer"
145 >gconstpointer</a> p);
146 <a
147 href="../glib/glib-Doubly-Linked-Lists.html#GList"
148 >GList</a>*      <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-list-parse">gnome_vfs_uri_list_parse</a>        (const <a
149 href="../glib/glib-Basic-Types.html#gchar"
150 >gchar</a> *uri_list);
151 <a
152 href="../glib/glib-Doubly-Linked-Lists.html#GList"
153 >GList</a>*      <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-list-ref">gnome_vfs_uri_list_ref</a>          (<a
154 href="../glib/glib-Doubly-Linked-Lists.html#GList"
155 >GList</a> *list);
156 <a
157 href="../glib/glib-Doubly-Linked-Lists.html#GList"
158 >GList</a>*      <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-list-unref">gnome_vfs_uri_list_unref</a>        (<a
159 href="../glib/glib-Doubly-Linked-Lists.html#GList"
160 >GList</a> *list);
161 <a
162 href="../glib/glib-Doubly-Linked-Lists.html#GList"
163 >GList</a>*      <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-list-copy">gnome_vfs_uri_list_copy</a>         (<a
164 href="../glib/glib-Doubly-Linked-Lists.html#GList"
165 >GList</a> *list);
166 void        <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-list-free">gnome_vfs_uri_list_free</a>         (<a
167 href="../glib/glib-Doubly-Linked-Lists.html#GList"
168 >GList</a> *list);
169 char*       <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-make-full-from-relative">gnome_vfs_uri_make_full_from_relative</a>
170                                             (const char *base_uri,
171                                              const char *relative_uri);
172 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
173
174 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="GnomeVFSToplevelURI"></a>GnomeVFSToplevelURI</h3><a class="indexterm" name="id2938080"></a><pre class="programlisting">typedef struct {
175         /* Base object.  */
176         GnomeVFSURI uri;
177
178         /* Server location information.  */
179         gchar *host_name;
180         guint host_port;
181
182         /* Authorization information.  */
183         gchar *user_name;
184         gchar *password;
185
186         /* The parent URN, if it exists */
187         gchar *urn;
188
189         /* Reserved to avoid future breaks in ABI compatibility */
190         void *reserved1;
191         void *reserved2;
192
193 } GnomeVFSToplevelURI;
194 </pre><p>
195
196 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GnomeVFSURIHideOptions"></a>enum GnomeVFSURIHideOptions</h3><a class="indexterm" name="id2938120"></a><pre class="programlisting">typedef enum {
197         GNOME_VFS_URI_HIDE_NONE = 0,
198         GNOME_VFS_URI_HIDE_USER_NAME = 1 &lt;&lt; 0,
199         GNOME_VFS_URI_HIDE_PASSWORD = 1 &lt;&lt; 1,
200         GNOME_VFS_URI_HIDE_HOST_NAME = 1 &lt;&lt; 2,
201         GNOME_VFS_URI_HIDE_HOST_PORT = 1 &lt;&lt; 3,
202         GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD = 1 &lt;&lt; 4,
203         GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER = 1 &lt;&lt; 8
204 } GnomeVFSURIHideOptions;
205 </pre><p>
206 Packed boolean bitfield controlling hiding of various elements
207 of a GnomeVFSURI when it is converted to a string.</p><p>
208
209 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><tt class="literal">GNOME_VFS_URI_HIDE_NONE</tt></span></td><td> don't hide anything
210 </td></tr><tr><td><span class="term"><tt class="literal">GNOME_VFS_URI_HIDE_USER_NAME</tt></span></td><td> hide the user name
211 </td></tr><tr><td><span class="term"><tt class="literal">GNOME_VFS_URI_HIDE_PASSWORD</tt></span></td><td> hide the password
212 </td></tr><tr><td><span class="term"><tt class="literal">GNOME_VFS_URI_HIDE_HOST_NAME</tt></span></td><td> hide the host name
213 </td></tr><tr><td><span class="term"><tt class="literal">GNOME_VFS_URI_HIDE_HOST_PORT</tt></span></td><td> hide the port
214 </td></tr><tr><td><span class="term"><tt class="literal">GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD</tt></span></td><td> hide the method (e.g. http, file)
215 </td></tr><tr><td><span class="term"><tt class="literal">GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER</tt></span></td><td> hide the fragment identifier
216 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-URI-MAGIC-CHR-CAPS"></a>GNOME_VFS_URI_MAGIC_CHR</h3><a class="indexterm" name="id2938304"></a><pre class="programlisting">#define GNOME_VFS_URI_MAGIC_CHR      '#'
217 </pre><p>
218 The character used to divide location from
219 extra "arguments" passed to the method.</p><p>
220
221 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-URI-MAGIC-STR-CAPS"></a>GNOME_VFS_URI_MAGIC_STR</h3><a class="indexterm" name="id2938343"></a><pre class="programlisting">#define GNOME_VFS_URI_MAGIC_STR "#"
222 </pre><p>
223 The character used to divide location from
224 extra "arguments" passed to the method.</p><p>
225
226 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-URI-PATH-CHR-CAPS"></a>GNOME_VFS_URI_PATH_CHR</h3><a class="indexterm" name="id2938381"></a><pre class="programlisting">#define GNOME_VFS_URI_PATH_CHR '/'
227 </pre><p>
228 Defines the path seperator character.</p><p>
229
230 </p></div><hr><div class="refsect2" lang="en"><h3><a name="GNOME-VFS-URI-PATH-STR-CAPS"></a>GNOME_VFS_URI_PATH_STR</h3><a class="indexterm" name="id2938418"></a><pre class="programlisting">#define GNOME_VFS_URI_PATH_STR "/"
231 </pre><p>
232 Defines the path seperator string.</p><p>
233
234 </p></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-new"></a>gnome_vfs_uri_new ()</h3><a class="indexterm" name="id2938453"></a><pre class="programlisting">GnomeVFSURI* gnome_vfs_uri_new              (const <a
235 href="../glib/glib-Basic-Types.html#gchar"
236 >gchar</a> *text_uri);</pre><p>
237 Create a new URI from <i class="parameter"><tt>text_uri</tt></i>. Unsupported and unsafe methods
238 are not allowed and will result in <tt class="literal">null</tt>% being returned. URL
239 transforms are allowed.</p><p>
240
241 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>text_uri</tt></i> :</span></td><td> A string representing a URI.
242 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The new URI.
243 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-resolve-relative"></a>gnome_vfs_uri_resolve_relative ()</h3><a class="indexterm" name="id2938556"></a><pre class="programlisting">GnomeVFSURI* gnome_vfs_uri_resolve_relative (const GnomeVFSURI *base,
244                                              const <a
245 href="../glib/glib-Basic-Types.html#gchar"
246 >gchar</a> *relative_reference);</pre><p>
247 Create a new URI from <i class="parameter"><tt>relative_reference</tt></i>, relative to <i class="parameter"><tt>base</tt></i>.</p><p>
248
249 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>base</tt></i> :</span></td><td> The base URI.
250 </td></tr><tr><td><span class="term"><i class="parameter"><tt>relative_reference</tt></i> :</span></td><td> A string representing a possibly relative URI reference
251 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The new URI.
252 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-ref"></a>gnome_vfs_uri_ref ()</h3><a class="indexterm" name="id2938683"></a><pre class="programlisting">GnomeVFSURI* gnome_vfs_uri_ref              (GnomeVFSURI *uri);</pre><p>
253 Increment <i class="parameter"><tt>uri</tt></i>'s reference count.</p><p>
254
255 </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> A GnomeVFSURI.
256 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <i class="parameter"><tt>uri</tt></i>.
257 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-unref"></a>gnome_vfs_uri_unref ()</h3><a class="indexterm" name="id2938782"></a><pre class="programlisting">void        gnome_vfs_uri_unref             (GnomeVFSURI *uri);</pre><p>
258 Decrement <i class="parameter"><tt>uri</tt></i>'s reference count.  If the reference count reaches zero,
259 <i class="parameter"><tt>uri</tt></i> is destroyed.</p><p>
260
261 </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> A GnomeVFSURI.
262 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-append-string"></a>gnome_vfs_uri_append_string ()</h3><a class="indexterm" name="id2938871"></a><pre class="programlisting">GnomeVFSURI* gnome_vfs_uri_append_string    (const GnomeVFSURI *uri,
263                                              const char *uri_fragment);</pre><p>
264 Create a new URI obtained by appending <i class="parameter"><tt>path</tt></i> to <i class="parameter"><tt>uri</tt></i>.  This will take care
265 of adding an appropriate directory separator between the end of <i class="parameter"><tt>uri</tt></i> and
266 the start of <i class="parameter"><tt>path</tt></i> if necessary.</p><p>
267
268 </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> A GnomeVFSURI.
269 </td></tr><tr><td><span class="term"><i class="parameter"><tt>uri_fragment</tt></i> :</span></td><td> A piece of a URI (ie a fully escaped partial path)
270 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The new URI obtained by combining <i class="parameter"><tt>uri</tt></i> and <i class="parameter"><tt>path</tt></i>.
271 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-append-path"></a>gnome_vfs_uri_append_path ()</h3><a class="indexterm" name="id2939028"></a><pre class="programlisting">GnomeVFSURI* gnome_vfs_uri_append_path      (const GnomeVFSURI *uri,
272                                              const char *path);</pre><p>
273 Create a new URI obtained by appending <i class="parameter"><tt>path</tt></i> to <i class="parameter"><tt>uri</tt></i>.  This will take care
274 of adding an appropriate directory separator between the end of <i class="parameter"><tt>uri</tt></i> and
275 the start of <i class="parameter"><tt>path</tt></i> if necessary as well as escaping <i class="parameter"><tt>path</tt></i> as necessary.</p><p>
276
277 </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> A GnomeVFSURI.
278 </td></tr><tr><td><span class="term"><i class="parameter"><tt>path</tt></i> :</span></td><td> A non-escaped file path
279 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The new URI obtained by combining <i class="parameter"><tt>uri</tt></i> and <i class="parameter"><tt>path</tt></i>.
280 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-append-file-name"></a>gnome_vfs_uri_append_file_name ()</h3><a class="indexterm" name="id2939190"></a><pre class="programlisting">GnomeVFSURI* gnome_vfs_uri_append_file_name (const GnomeVFSURI *uri,
281                                              const <a
282 href="../glib/glib-Basic-Types.html#gchar"
283 >gchar</a> *filename);</pre><p>
284 Create a new URI obtained by appending <i class="parameter"><tt>file_name</tt></i> to <i class="parameter"><tt>uri</tt></i>.  This will take care
285 of adding an appropriate directory separator between the end of <i class="parameter"><tt>uri</tt></i> and
286 the start of <i class="parameter"><tt>file_name</tt></i> if necessary.</p><p>
287
288 </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> A GnomeVFSURI.
289 </td></tr><tr><td><span class="term"><i class="parameter"><tt>filename</tt></i> :</span></td><td> any "regular" file name (can include #, /, etc)
290 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The new URI obtained by combining <i class="parameter"><tt>uri</tt></i> and <i class="parameter"><tt>path</tt></i>.
291 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-to-string"></a>gnome_vfs_uri_to_string ()</h3><a class="indexterm" name="id2939346"></a><pre class="programlisting"><a
292 href="../glib/glib-Basic-Types.html#gchar"
293 >gchar</a>*      gnome_vfs_uri_to_string         (const GnomeVFSURI *uri,
294                                              <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURIHideOptions">GnomeVFSURIHideOptions</a> hide_options);</pre><p>
295 Translate <i class="parameter"><tt>uri</tt></i> into a printable string.  The string will not contain the
296 URI elements specified by <i class="parameter"><tt>hide_options</tt></i>.</p><p>
297
298 </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> A GnomeVFSURI.
299 </td></tr><tr><td><span class="term"><i class="parameter"><tt>hide_options</tt></i> :</span></td><td> Bitmask specifying what URI elements (e.g. password,
300 user name etc.) should not be represented in the returned string.
301 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A malloced printable string representing <i class="parameter"><tt>uri</tt></i>.
302 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-dup"></a>gnome_vfs_uri_dup ()</h3><a class="indexterm" name="id2939483"></a><pre class="programlisting">GnomeVFSURI* gnome_vfs_uri_dup              (const GnomeVFSURI *uri);</pre><p>
303 Duplicate <i class="parameter"><tt>uri</tt></i>.</p><p>
304
305 </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> A GnomeVFSURI.
306 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A pointer to a new URI that is exactly the same as <i class="parameter"><tt>uri</tt></i>.
307 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-is-local"></a>gnome_vfs_uri_is_local ()</h3><a class="indexterm" name="id2939584"></a><pre class="programlisting"><a
308 href="../glib/glib-Basic-Types.html#gboolean"
309 >gboolean</a>    gnome_vfs_uri_is_local          (const GnomeVFSURI *uri);</pre><p>
310 Check if <i class="parameter"><tt>uri</tt></i> is a local (native) file system.</p><p>
311
312 </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> A GnomeVFSURI.
313 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">FALSE</tt> if <i class="parameter"><tt>uri</tt></i> is not a local file system, <tt class="literal">TRUE</tt> otherwise.
314 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-has-parent"></a>gnome_vfs_uri_has_parent ()</h3><a class="indexterm" name="id2939698"></a><pre class="programlisting"><a
315 href="../glib/glib-Basic-Types.html#gboolean"
316 >gboolean</a>    gnome_vfs_uri_has_parent        (const GnomeVFSURI *uri);</pre><p>
317 Check if URI has a parent or not.</p><p>
318
319 </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> A GnomeVFSURI.
320 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if <i class="parameter"><tt>uri</tt></i> has a parent, <tt class="literal">FALSE</tt> otherwise.
321 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-parent"></a>gnome_vfs_uri_get_parent ()</h3><a class="indexterm" name="id2939805"></a><pre class="programlisting">GnomeVFSURI* gnome_vfs_uri_get_parent       (const GnomeVFSURI *uri);</pre><p>
322 Retrieve <i class="parameter"><tt>uri</tt></i>'s parent URI.</p><p>
323
324 </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> A GnomeVFSURI.
325 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A pointer to <i class="parameter"><tt>uri</tt></i>'s parent URI.
326 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-toplevel"></a>gnome_vfs_uri_get_toplevel ()</h3><a class="indexterm" name="id2939904"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSToplevelURI">GnomeVFSToplevelURI</a>* gnome_vfs_uri_get_toplevel
327                                             (const GnomeVFSURI *uri);</pre><p>
328 Retrieve the toplevel URI in <i class="parameter"><tt>uri</tt></i>.</p><p>
329
330 </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> A GnomeVFSURI.
331 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A pointer to the toplevel URI object.
332 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-host-name"></a>gnome_vfs_uri_get_host_name ()</h3><a class="indexterm" name="id2940002"></a><pre class="programlisting">const <a
333 href="../glib/glib-Basic-Types.html#gchar"
334 >gchar</a>* gnome_vfs_uri_get_host_name    (const GnomeVFSURI *uri);</pre><p>
335 Retrieve the host name for <i class="parameter"><tt>uri</tt></i>.</p><p>
336
337 </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> A GnomeVFSURI.
338 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A string representing the host name.
339 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-scheme"></a>gnome_vfs_uri_get_scheme ()</h3><a class="indexterm" name="id2940096"></a><pre class="programlisting">const <a
340 href="../glib/glib-Basic-Types.html#gchar"
341 >gchar</a>* gnome_vfs_uri_get_scheme       (const GnomeVFSURI *uri);</pre><p>
342 Retrieve the scheme used for <i class="parameter"><tt>uri</tt></i></p><p>
343
344 </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> A GnomeVFSURI
345 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A string representing the scheme
346 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-host-port"></a>gnome_vfs_uri_get_host_port ()</h3><a class="indexterm" name="id2940190"></a><pre class="programlisting"><a
347 href="../glib/glib-Basic-Types.html#guint"
348 >guint</a>       gnome_vfs_uri_get_host_port     (const GnomeVFSURI *uri);</pre><p>
349 Retrieve the host port number in <i class="parameter"><tt>uri</tt></i>.</p><p>
350
351 </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> A GnomeVFSURI.
352 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The host port number used by <i class="parameter"><tt>uri</tt></i>.  If the value is zero, the
353 default port value for the specified toplevel access method is used.
354 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-user-name"></a>gnome_vfs_uri_get_user_name ()</h3><a class="indexterm" name="id2940292"></a><pre class="programlisting">const <a
355 href="../glib/glib-Basic-Types.html#gchar"
356 >gchar</a>* gnome_vfs_uri_get_user_name    (const GnomeVFSURI *uri);</pre><p>
357 Retrieve the user name in <i class="parameter"><tt>uri</tt></i>.</p><p>
358
359 </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> A GnomeVFSURI.
360 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A string representing the user name in <i class="parameter"><tt>uri</tt></i>.
361 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-password"></a>gnome_vfs_uri_get_password ()</h3><a class="indexterm" name="id2940394"></a><pre class="programlisting">const <a
362 href="../glib/glib-Basic-Types.html#gchar"
363 >gchar</a>* gnome_vfs_uri_get_password     (const GnomeVFSURI *uri);</pre><p>
364 Retrieve the password for <i class="parameter"><tt>uri</tt></i>.</p><p>
365
366 </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> A GnomeVFSURI.
367 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The password for <i class="parameter"><tt>uri</tt></i>.
368 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-set-host-name"></a>gnome_vfs_uri_set_host_name ()</h3><a class="indexterm" name="id2940496"></a><pre class="programlisting">void        gnome_vfs_uri_set_host_name     (GnomeVFSURI *uri,
369                                              const <a
370 href="../glib/glib-Basic-Types.html#gchar"
371 >gchar</a> *host_name);</pre><p>
372 Set <i class="parameter"><tt>host_name</tt></i> as the host name accessed by <i class="parameter"><tt>uri</tt></i>.</p><p>
373
374 </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> A GnomeVFSURI.
375 </td></tr><tr><td><span class="term"><i class="parameter"><tt>host_name</tt></i> :</span></td><td> A string representing a host name.
376 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-set-host-port"></a>gnome_vfs_uri_set_host_port ()</h3><a class="indexterm" name="id2940610"></a><pre class="programlisting">void        gnome_vfs_uri_set_host_port     (GnomeVFSURI *uri,
377                                              <a
378 href="../glib/glib-Basic-Types.html#guint"
379 >guint</a> host_port);</pre><p>
380 Set the host port number in <i class="parameter"><tt>uri</tt></i>.  If <i class="parameter"><tt>host_port</tt></i> is zero, the default port
381 for <i class="parameter"><tt>uri</tt></i>'s toplevel access method is used.</p><p>
382
383 </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> A GnomeVFSURI.
384 </td></tr><tr><td><span class="term"><i class="parameter"><tt>host_port</tt></i> :</span></td><td> A TCP/IP port number.
385 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-set-user-name"></a>gnome_vfs_uri_set_user_name ()</h3><a class="indexterm" name="id2940731"></a><pre class="programlisting">void        gnome_vfs_uri_set_user_name     (GnomeVFSURI *uri,
386                                              const <a
387 href="../glib/glib-Basic-Types.html#gchar"
388 >gchar</a> *user_name);</pre><p>
389 Set <i class="parameter"><tt>user_name</tt></i> as the user name for <i class="parameter"><tt>uri</tt></i>.</p><p>
390
391 </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> A GnomeVFSURI.
392 </td></tr><tr><td><span class="term"><i class="parameter"><tt>user_name</tt></i> :</span></td><td> A string representing a user name on the host accessed by <i class="parameter"><tt>uri</tt></i>.
393 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-set-password"></a>gnome_vfs_uri_set_password ()</h3><a class="indexterm" name="id2940850"></a><pre class="programlisting">void        gnome_vfs_uri_set_password      (GnomeVFSURI *uri,
394                                              const <a
395 href="../glib/glib-Basic-Types.html#gchar"
396 >gchar</a> *password);</pre><p>
397 Set <i class="parameter"><tt>password</tt></i> as the password for <i class="parameter"><tt>uri</tt></i>.</p><p>
398
399 </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> A GnomeVFSURI.
400 </td></tr><tr><td><span class="term"><i class="parameter"><tt>password</tt></i> :</span></td><td> A password string.
401 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-equal"></a>gnome_vfs_uri_equal ()</h3><a class="indexterm" name="id2940964"></a><pre class="programlisting"><a
402 href="../glib/glib-Basic-Types.html#gboolean"
403 >gboolean</a>    gnome_vfs_uri_equal             (const GnomeVFSURI *a,
404                                              const GnomeVFSURI *b);</pre><p>
405 Compare <i class="parameter"><tt>a</tt></i> and <i class="parameter"><tt>b</tt></i>.</p><p>
406
407 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>a</tt></i> :</span></td><td> A GnomeVFSURI.
408 </td></tr><tr><td><span class="term"><i class="parameter"><tt>b</tt></i> :</span></td><td> A GnomeVFSURI.
409 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if <i class="parameter"><tt>a</tt></i> and <i class="parameter"><tt>b</tt></i> are equal, <tt class="literal">FALSE</tt> otherwise.
410
411 FIXME: This comparison should take into account the possiblity
412 that unreserved characters may be escaped.
413 ...or perhaps gnome_vfs_uri_new should unescape unreserved characters?
414 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-is-parent"></a>gnome_vfs_uri_is_parent ()</h3><a class="indexterm" name="id2941120"></a><pre class="programlisting"><a
415 href="../glib/glib-Basic-Types.html#gboolean"
416 >gboolean</a>    gnome_vfs_uri_is_parent         (const GnomeVFSURI *possible_parent,
417                                              const GnomeVFSURI *possible_child,
418                                              <a
419 href="../glib/glib-Basic-Types.html#gboolean"
420 >gboolean</a> recursive);</pre><p>
421 Check if <i class="parameter"><tt>possible_child</tt></i> is contained by <i class="parameter"><tt>possible_parent</tt></i>.
422 If <i class="parameter"><tt>recursive</tt></i> is FALSE, just try the immediate parent directory, else
423 search up through the hierarchy.</p><p>
424
425 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>possible_parent</tt></i> :</span></td><td> A GnomeVFSURI.
426 </td></tr><tr><td><span class="term"><i class="parameter"><tt>possible_child</tt></i> :</span></td><td> A GnomeVFSURI.
427 </td></tr><tr><td><span class="term"><i class="parameter"><tt>recursive</tt></i> :</span></td><td> a flag to turn recursive check on.
428 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if <i class="parameter"><tt>possible_child</tt></i> is contained in  <i class="parameter"><tt>possible_child</tt></i>.
429 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-path"></a>gnome_vfs_uri_get_path ()</h3><a class="indexterm" name="id2941302"></a><pre class="programlisting">const <a
430 href="../glib/glib-Basic-Types.html#gchar"
431 >gchar</a>* gnome_vfs_uri_get_path         (const GnomeVFSURI *uri);</pre><p>
432 Retrieve full path name for <i class="parameter"><tt>uri</tt></i>.</p><p>
433
434 </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> A GnomeVFSURI
435 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A pointer to the full path name in <i class="parameter"><tt>uri</tt></i>.  Notice that the
436 pointer points to the name store in <i class="parameter"><tt>uri</tt></i>, so the name returned must not
437 be modified nor freed.
438 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-get-fragment-identifier"></a>gnome_vfs_uri_get_fragment_identifier ()</h3><a class="indexterm" name="id2941414"></a><pre class="programlisting">const <a
439 href="../glib/glib-Basic-Types.html#gchar"
440 >gchar</a>* gnome_vfs_uri_get_fragment_identifier
441                                             (const GnomeVFSURI *uri);</pre><p>
442
443 </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>
444 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
445
446
447 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-extract-dirname"></a>gnome_vfs_uri_extract_dirname ()</h3><a class="indexterm" name="id2941499"></a><pre class="programlisting"><a
448 href="../glib/glib-Basic-Types.html#gchar"
449 >gchar</a>*      gnome_vfs_uri_extract_dirname   (const GnomeVFSURI *uri);</pre><p>
450 Extract the name of the directory in which the file pointed to by <i class="parameter"><tt>uri</tt></i> is
451 stored as a newly allocated string.  The string will end with a
452 GNOME_VFS_URI_PATH_CHR.</p><p>
453
454 </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> A GnomeVFSURI
455 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A pointer to the newly allocated string representing the
456 parent directory.
457 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-extract-short-name"></a>gnome_vfs_uri_extract_short_name ()</h3><a class="indexterm" name="id2941597"></a><pre class="programlisting"><a
458 href="../glib/glib-Basic-Types.html#gchar"
459 >gchar</a>*      gnome_vfs_uri_extract_short_name
460                                             (const GnomeVFSURI *uri);</pre><p>
461 Retrieve base file name for <i class="parameter"><tt>uri</tt></i>, ignoring any trailing path separators.
462 This matches the XPG definition of basename, but not g_basename. This is
463 often useful when you want the name of something that's pointed to by a
464 uri, and don't care whether the uri has a directory or file form.
465 If <i class="parameter"><tt>uri</tt></i> points to the root of a domain, returns the host name. If there's
466 no host name, returns GNOME_VFS_URI_PATH_STR.
467 </p><p>
468 See also: gnome_vfs_uri_extract_short_path_name.</p><p>
469
470 </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> A GnomeVFSURI
471 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A pointer to the newly allocated string representing the
472 unescaped short form of the name.
473 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-extract-short-path-name"></a>gnome_vfs_uri_extract_short_path_name ()</h3><a class="indexterm" name="id2941713"></a><pre class="programlisting"><a
474 href="../glib/glib-Basic-Types.html#gchar"
475 >gchar</a>*      gnome_vfs_uri_extract_short_path_name
476                                             (const GnomeVFSURI *uri);</pre><p>
477 Retrieve base file name for <i class="parameter"><tt>uri</tt></i>, ignoring any trailing path separators.
478 This matches the XPG definition of basename, but not g_basename. This is
479 often useful when you want the name of something that's pointed to by a
480 uri, and don't care whether the uri has a directory or file form.
481 If <i class="parameter"><tt>uri</tt></i> points to the root (including the root of any domain),
482 returns GNOME_VFS_URI_PATH_STR.
483 </p><p>
484 See also: gnome_vfs_uri_extract_short_name.</p><p>
485
486 </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> A GnomeVFSURI
487 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A pointer to the newly allocated string representing the
488 escaped short form of the name.
489 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-hequal"></a>gnome_vfs_uri_hequal ()</h3><a class="indexterm" name="id2941826"></a><pre class="programlisting"><a
490 href="../glib/glib-Basic-Types.html#gint"
491 >gint</a>        gnome_vfs_uri_hequal            (<a
492 href="../glib/glib-Basic-Types.html#gconstpointer"
493 >gconstpointer</a> a,
494                                              <a
495 href="../glib/glib-Basic-Types.html#gconstpointer"
496 >gconstpointer</a> b);</pre><p>
497 Function intended for use as a hash table "are these two items
498 the same" comparison. Useful for creating a hash table of URIs.</p><p>
499
500 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>a</tt></i> :</span></td><td> a pointer to a GnomeVFSURI
501 </td></tr><tr><td><span class="term"><i class="parameter"><tt>b</tt></i> :</span></td><td> a pointer to a GnomeVFSURI
502 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if the URIs are the same
503 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-hash"></a>gnome_vfs_uri_hash ()</h3><a class="indexterm" name="id2941949"></a><pre class="programlisting"><a
504 href="../glib/glib-Basic-Types.html#guint"
505 >guint</a>       gnome_vfs_uri_hash              (<a
506 href="../glib/glib-Basic-Types.html#gconstpointer"
507 >gconstpointer</a> p);</pre><p>
508 Creates an integer value from a GnomeVFSURI, appropriate
509 for using as the key to a hash table entry.</p><p>
510
511 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>p</tt></i> :</span></td><td> a pointer to a GnomeVFSURI
512 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a hash key corresponding to <i class="parameter"><tt>p</tt></i>
513 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-list-parse"></a>gnome_vfs_uri_list_parse ()</h3><a class="indexterm" name="id2942045"></a><pre class="programlisting"><a
514 href="../glib/glib-Doubly-Linked-Lists.html#GList"
515 >GList</a>*      gnome_vfs_uri_list_parse        (const <a
516 href="../glib/glib-Basic-Types.html#gchar"
517 >gchar</a> *uri_list);</pre><p>
518 Extracts a list of <span class="type">GnomeVFSURI</span> objects from a standard text/uri-list,
519 such as one you would get on a drop operation.  Use
520 <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-list-free"><span class="type">gnome_vfs_uri_list_free</span></a> when you are done with the list.</p><p>
521
522 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>uri_list</tt></i> :</span></td><td>
523 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A GList of GnomeVFSURIs
524 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-list-ref"></a>gnome_vfs_uri_list_ref ()</h3><a class="indexterm" name="id2942153"></a><pre class="programlisting"><a
525 href="../glib/glib-Doubly-Linked-Lists.html#GList"
526 >GList</a>*      gnome_vfs_uri_list_ref          (<a
527 href="../glib/glib-Doubly-Linked-Lists.html#GList"
528 >GList</a> *list);</pre><p>
529 Increments the reference count of the items in <i class="parameter"><tt>list</tt></i> by one.</p><p>
530
531 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>list</tt></i> :</span></td><td> list of GnomeVFSURI elements
532 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <i class="parameter"><tt>list</tt></i>
533 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-list-unref"></a>gnome_vfs_uri_list_unref ()</h3><a class="indexterm" name="id2942254"></a><pre class="programlisting"><a
534 href="../glib/glib-Doubly-Linked-Lists.html#GList"
535 >GList</a>*      gnome_vfs_uri_list_unref        (<a
536 href="../glib/glib-Doubly-Linked-Lists.html#GList"
537 >GList</a> *list);</pre><p>
538 Decrements the reference count of the items in <i class="parameter"><tt>list</tt></i> by one.
539 Note that the list is *not freed* even if each member of the list
540 is freed.</p><p>
541
542 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>list</tt></i> :</span></td><td> list of GnomeVFSURI elements
543 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <i class="parameter"><tt>list</tt></i>
544 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-list-copy"></a>gnome_vfs_uri_list_copy ()</h3><a class="indexterm" name="id2942356"></a><pre class="programlisting"><a
545 href="../glib/glib-Doubly-Linked-Lists.html#GList"
546 >GList</a>*      gnome_vfs_uri_list_copy         (<a
547 href="../glib/glib-Doubly-Linked-Lists.html#GList"
548 >GList</a> *list);</pre><p>
549 Creates a duplicate of <i class="parameter"><tt>list</tt></i>, and references each member of
550 that list.</p><p>
551
552 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>list</tt></i> :</span></td><td> list of GnomeVFSURI elements
553 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a newly referenced duplicate of <i class="parameter"><tt>list</tt></i>
554 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-list-free"></a>gnome_vfs_uri_list_free ()</h3><a class="indexterm" name="id2942457"></a><pre class="programlisting">void        gnome_vfs_uri_list_free         (<a
555 href="../glib/glib-Doubly-Linked-Lists.html#GList"
556 >GList</a> *list);</pre><p>
557 Decrements the reference count of each member of <i class="parameter"><tt>list</tt></i> by one,
558 and frees the list itself.</p><p>
559
560 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>list</tt></i> :</span></td><td> list of GnomeVFSURI elements
561 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-uri-make-full-from-relative"></a>gnome_vfs_uri_make_full_from_relative ()</h3><a class="indexterm" name="id2942540"></a><pre class="programlisting">char*       gnome_vfs_uri_make_full_from_relative
562                                             (const char *base_uri,
563                                              const char *relative_uri);</pre><p>
564 Returns a full URI given a full base URI, and a secondary URI which may
565 be relative.</p><p>
566
567 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>base_uri</tt></i> :</span></td><td> a string representing the base URI
568 </td></tr><tr><td><span class="term"><i class="parameter"><tt>relative_uri</tt></i> :</span></td><td> a URI fragment/reference to be appended to <i class="parameter"><tt>base_uri</tt></i>
569 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a newly allocated string containing the URI 
570 (NULL for some bad errors).
571 </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-20-gnome-vfs-result.html"><b>&lt;&lt; GnomeVFSResult</b></a></td><td align="right"><a accesskey="n" href="mime-registry.html"><b>MIME Registry &gt;&gt;</b></a></td></tr></table></body></html>