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