← Back to branch summary

~adam-stokes/ubuntu/quantal/gnome-vfs/lp977940-multiarch

« back to all changes in this revision

Viewing changes to doc/xml/gnome-vfs-uri.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-08-05 10:31:15 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080805103115-5vkex0yk6qq619x5
Tags: 1:2.23.0-0ubuntu1
* New upstream version:
  - Sync xdgmime with GIO
* debian/patches/90_from_svn_no_range_for_youtube.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gnome-vfs-uri.xml
1
1
<refentry id="gnome-vfs-20-gnome-vfs-uri">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page">GnomeVFSURI</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-uri.top_of_page">GnomeVFSURI</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
6
6
</refmeta>
12
12
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
13
13
</refnamediv>
14
14
 
15
 
<refsynopsisdiv role="synopsis">
 
15
<refsynopsisdiv id="gnome-vfs-20-gnome-vfs-uri.synopsis" role="synopsis">
16
16
<title role="synopsis.title">Synopsis</title>
17
17
 
18
18
<synopsis>
19
 
 
20
 
 
21
 
 
22
19
                    <link linkend="GnomeVFSURI">GnomeVFSURI</link>;
23
20
                    <link linkend="GnomeVFSToplevelURI">GnomeVFSToplevelURI</link>;
24
21
enum                <link linkend="GnomeVFSURIHideOptions">GnomeVFSURIHideOptions</link>;
93
90
 
94
91
 
95
92
 
96
 
<refsect1 role="desc">
 
93
<refsect1 id="gnome-vfs-20-gnome-vfs-uri.description" role="desc">
97
94
<title role="desc.title">Description</title>
98
95
<para>
99
96
  A <link linkend="GnomeVFSURI"><type>GnomeVFSURI</type></link> is a semi-textual representation
105
102
</para>
106
103
</refsect1>
107
104
 
108
 
<refsect1 role="details">
 
105
<refsect1 id="gnome-vfs-20-gnome-vfs-uri.details" role="details">
109
106
<title role="details.title">Details</title>
110
 
<refsect2>
111
 
<title><anchor id="GnomeVFSURI" role="struct"/>GnomeVFSURI</title>
112
 
<indexterm><primary>GnomeVFSURI</primary></indexterm><programlisting>typedef struct {
 
107
<refsect2 id="GnomeVFSURI" role="struct">
 
108
<title>GnomeVFSURI</title>
 
109
<indexterm zone="GnomeVFSURI"><primary>GnomeVFSURI</primary></indexterm><programlisting>typedef struct {
113
110
        guint ref_count;
114
111
 
115
112
        gchar *text;
160
157
</simpara></listitem>
161
158
</varlistentry>
162
159
</variablelist></refsect2>
163
 
<refsect2>
164
 
<title><anchor id="GnomeVFSToplevelURI" role="struct"/>GnomeVFSToplevelURI</title>
165
 
<indexterm><primary>GnomeVFSToplevelURI</primary></indexterm><programlisting>typedef struct {
 
160
<refsect2 id="GnomeVFSToplevelURI" role="struct">
 
161
<title>GnomeVFSToplevelURI</title>
 
162
<indexterm zone="GnomeVFSToplevelURI"><primary>GnomeVFSToplevelURI</primary></indexterm><programlisting>typedef struct {
166
163
        GnomeVFSURI uri;
167
164
 
168
165
        gchar *host_name;
215
212
</simpara></listitem>
216
213
</varlistentry>
217
214
</variablelist></refsect2>
218
 
<refsect2>
219
 
<title><anchor id="GnomeVFSURIHideOptions" role="enum"/>enum GnomeVFSURIHideOptions</title>
220
 
<indexterm><primary>GnomeVFSURIHideOptions</primary></indexterm><programlisting>typedef enum
 
215
<refsect2 id="GnomeVFSURIHideOptions" role="enum">
 
216
<title>enum GnomeVFSURIHideOptions</title>
 
217
<indexterm zone="GnomeVFSURIHideOptions"><primary>GnomeVFSURIHideOptions</primary></indexterm><programlisting>typedef enum
221
218
{
222
219
        GNOME_VFS_URI_HIDE_NONE = 0,
223
220
        GNOME_VFS_URI_HIDE_USER_NAME = 1 &lt;&lt; 0,
235
232
<para>
236
233
 
237
234
</para><variablelist role="enum">
238
 
<varlistentry>
239
 
<term><anchor id="GNOME-VFS-URI-HIDE-NONE:CAPS" role="constant"/><literal>GNOME_VFS_URI_HIDE_NONE</literal></term>
 
235
<varlistentry id="GNOME-VFS-URI-HIDE-NONE:CAPS" role="constant">
 
236
<term><literal>GNOME_VFS_URI_HIDE_NONE</literal></term>
240
237
<listitem><simpara> don't hide anything
241
238
</simpara></listitem>
242
239
</varlistentry>
243
 
<varlistentry>
244
 
<term><anchor id="GNOME-VFS-URI-HIDE-USER-NAME:CAPS" role="constant"/><literal>GNOME_VFS_URI_HIDE_USER_NAME</literal></term>
 
240
<varlistentry id="GNOME-VFS-URI-HIDE-USER-NAME:CAPS" role="constant">
 
241
<term><literal>GNOME_VFS_URI_HIDE_USER_NAME</literal></term>
245
242
<listitem><simpara> hide the user name
246
243
</simpara></listitem>
247
244
</varlistentry>
248
 
<varlistentry>
249
 
<term><anchor id="GNOME-VFS-URI-HIDE-PASSWORD:CAPS" role="constant"/><literal>GNOME_VFS_URI_HIDE_PASSWORD</literal></term>
 
245
<varlistentry id="GNOME-VFS-URI-HIDE-PASSWORD:CAPS" role="constant">
 
246
<term><literal>GNOME_VFS_URI_HIDE_PASSWORD</literal></term>
250
247
<listitem><simpara> hide the password
251
248
</simpara></listitem>
252
249
</varlistentry>
253
 
<varlistentry>
254
 
<term><anchor id="GNOME-VFS-URI-HIDE-HOST-NAME:CAPS" role="constant"/><literal>GNOME_VFS_URI_HIDE_HOST_NAME</literal></term>
 
250
<varlistentry id="GNOME-VFS-URI-HIDE-HOST-NAME:CAPS" role="constant">
 
251
<term><literal>GNOME_VFS_URI_HIDE_HOST_NAME</literal></term>
255
252
<listitem><simpara> hide the host name
256
253
</simpara></listitem>
257
254
</varlistentry>
258
 
<varlistentry>
259
 
<term><anchor id="GNOME-VFS-URI-HIDE-HOST-PORT:CAPS" role="constant"/><literal>GNOME_VFS_URI_HIDE_HOST_PORT</literal></term>
 
255
<varlistentry id="GNOME-VFS-URI-HIDE-HOST-PORT:CAPS" role="constant">
 
256
<term><literal>GNOME_VFS_URI_HIDE_HOST_PORT</literal></term>
260
257
<listitem><simpara> hide the port
261
258
</simpara></listitem>
262
259
</varlistentry>
263
 
<varlistentry>
264
 
<term><anchor id="GNOME-VFS-URI-HIDE-TOPLEVEL-METHOD:CAPS" role="constant"/><literal>GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD</literal></term>
 
260
<varlistentry id="GNOME-VFS-URI-HIDE-TOPLEVEL-METHOD:CAPS" role="constant">
 
261
<term><literal>GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD</literal></term>
265
262
<listitem><simpara> hide the method (e.g. http, file)
266
263
</simpara></listitem>
267
264
</varlistentry>
268
 
<varlistentry>
269
 
<term><anchor id="GNOME-VFS-URI-HIDE-FRAGMENT-IDENTIFIER:CAPS" role="constant"/><literal>GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER</literal></term>
 
265
<varlistentry id="GNOME-VFS-URI-HIDE-FRAGMENT-IDENTIFIER:CAPS" role="constant">
 
266
<term><literal>GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER</literal></term>
270
267
<listitem><simpara> hide the fragment identifier
271
268
</simpara></listitem>
272
269
</varlistentry>
273
270
</variablelist></refsect2>
274
 
<refsect2>
275
 
<title><anchor id="GNOME-VFS-URI-MAGIC-CHR:CAPS" role="macro"/>GNOME_VFS_URI_MAGIC_CHR</title>
276
 
<indexterm><primary>GNOME_VFS_URI_MAGIC_CHR</primary></indexterm><programlisting>#define GNOME_VFS_URI_MAGIC_CHR        '#'
277
 
</programlisting>
278
 
<para>
279
 
The character used to divide location from
280
 
extra "arguments" passed to the method.</para>
281
 
<para>
282
 
 
283
 
</para></refsect2>
284
 
<refsect2>
285
 
<title><anchor id="GNOME-VFS-URI-MAGIC-STR:CAPS" role="macro"/>GNOME_VFS_URI_MAGIC_STR</title>
286
 
<indexterm><primary>GNOME_VFS_URI_MAGIC_STR</primary></indexterm><programlisting>#define GNOME_VFS_URI_MAGIC_STR "#"
287
 
</programlisting>
288
 
<para>
289
 
The character used to divide location from
290
 
extra "arguments" passed to the method.</para>
291
 
<para>
292
 
 
293
 
</para></refsect2>
294
 
<refsect2>
295
 
<title><anchor id="GNOME-VFS-URI-PATH-CHR:CAPS" role="macro"/>GNOME_VFS_URI_PATH_CHR</title>
296
 
<indexterm><primary>GNOME_VFS_URI_PATH_CHR</primary></indexterm><programlisting>#define GNOME_VFS_URI_PATH_CHR '/'
 
271
<refsect2 id="GNOME-VFS-URI-MAGIC-CHR:CAPS" role="macro">
 
272
<title>GNOME_VFS_URI_MAGIC_CHR</title>
 
273
<indexterm zone="GNOME-VFS-URI-MAGIC-CHR:CAPS"><primary>GNOME_VFS_URI_MAGIC_CHR</primary></indexterm><programlisting>#define GNOME_VFS_URI_MAGIC_CHR    '#'
 
274
</programlisting>
 
275
<para>
 
276
The character used to divide location from
 
277
extra "arguments" passed to the method.</para>
 
278
<para>
 
279
 
 
280
</para></refsect2>
 
281
<refsect2 id="GNOME-VFS-URI-MAGIC-STR:CAPS" role="macro">
 
282
<title>GNOME_VFS_URI_MAGIC_STR</title>
 
283
<indexterm zone="GNOME-VFS-URI-MAGIC-STR:CAPS"><primary>GNOME_VFS_URI_MAGIC_STR</primary></indexterm><programlisting>#define GNOME_VFS_URI_MAGIC_STR "#"
 
284
</programlisting>
 
285
<para>
 
286
The character used to divide location from
 
287
extra "arguments" passed to the method.</para>
 
288
<para>
 
289
 
 
290
</para></refsect2>
 
291
<refsect2 id="GNOME-VFS-URI-PATH-CHR:CAPS" role="macro">
 
292
<title>GNOME_VFS_URI_PATH_CHR</title>
 
293
<indexterm zone="GNOME-VFS-URI-PATH-CHR:CAPS"><primary>GNOME_VFS_URI_PATH_CHR</primary></indexterm><programlisting>#define GNOME_VFS_URI_PATH_CHR '/'
297
294
</programlisting>
298
295
<para>
299
296
Defines the path seperator character.</para>
300
297
<para>
301
298
 
302
299
</para></refsect2>
303
 
<refsect2>
304
 
<title><anchor id="GNOME-VFS-URI-PATH-STR:CAPS" role="macro"/>GNOME_VFS_URI_PATH_STR</title>
305
 
<indexterm><primary>GNOME_VFS_URI_PATH_STR</primary></indexterm><programlisting>#define GNOME_VFS_URI_PATH_STR "/"
 
300
<refsect2 id="GNOME-VFS-URI-PATH-STR:CAPS" role="macro">
 
301
<title>GNOME_VFS_URI_PATH_STR</title>
 
302
<indexterm zone="GNOME-VFS-URI-PATH-STR:CAPS"><primary>GNOME_VFS_URI_PATH_STR</primary></indexterm><programlisting>#define GNOME_VFS_URI_PATH_STR "/"
306
303
</programlisting>
307
304
<para>
308
305
Defines the path seperator string.</para>
309
306
<para>
310
307
 
311
308
</para></refsect2>
312
 
<refsect2>
313
 
<title><anchor id="gnome-vfs-uri-new" role="function"/>gnome_vfs_uri_new ()</title>
314
 
<indexterm><primary>gnome_vfs_uri_new</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_new                   (const <link linkend="gchar">gchar</link> *text_uri);</programlisting>
 
309
<refsect2 id="gnome-vfs-uri-new" role="function">
 
310
<title>gnome_vfs_uri_new ()</title>
 
311
<indexterm zone="gnome-vfs-uri-new"><primary>gnome_vfs_uri_new</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_new                   (const <link linkend="gchar">gchar</link> *text_uri);</programlisting>
315
312
<para>
316
313
Create a new uri from <parameter>text_uri</parameter>. Unsupported and unsafe methods
317
314
are not allowed and will result in <link linkend="NULL:CAPS"><literal>NULL</literal></link> being returned. URL
330
327
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new uri.
331
328
</simpara></listitem></varlistentry>
332
329
</variablelist></refsect2>
333
 
<refsect2>
334
 
<title><anchor id="gnome-vfs-uri-resolve-relative" role="function"/>gnome_vfs_uri_resolve_relative ()</title>
335
 
<indexterm><primary>gnome_vfs_uri_resolve_relative</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_resolve_relative      (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *base,
 
330
<refsect2 id="gnome-vfs-uri-resolve-relative" role="function">
 
331
<title>gnome_vfs_uri_resolve_relative ()</title>
 
332
<indexterm zone="gnome-vfs-uri-resolve-relative"><primary>gnome_vfs_uri_resolve_relative</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_resolve_relative      (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *base,
336
333
                                                         const <link linkend="gchar">gchar</link> *relative_reference);</programlisting>
337
334
<para>
338
335
Create a new uri from <parameter>relative_reference</parameter>, relative to <parameter>base</parameter>. The resolution
374
371
if <parameter>relative_reference</parameter> was malformed.
375
372
</simpara></listitem></varlistentry>
376
373
</variablelist></refsect2>
377
 
<refsect2>
378
 
<title><anchor id="gnome-vfs-uri-resolve-symbolic-link" role="function" condition="since:2.16"/>gnome_vfs_uri_resolve_symbolic_link ()</title>
379
 
<indexterm role="2.16"><primary>gnome_vfs_uri_resolve_symbolic_link</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_resolve_symbolic_link (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *base,
 
374
<refsect2 id="gnome-vfs-uri-resolve-symbolic-link" role="function" condition="since:2.16">
 
375
<title>gnome_vfs_uri_resolve_symbolic_link ()</title>
 
376
<indexterm zone="gnome-vfs-uri-resolve-symbolic-link" role="2.16"><primary>gnome_vfs_uri_resolve_symbolic_link</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_resolve_symbolic_link (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *base,
380
377
                                                         const <link linkend="gchar">gchar</link> *relative_reference);</programlisting>
381
378
<para>
382
379
Create a new uri from <parameter>symbolic_link</parameter>, relative to <parameter>base</parameter>.
398
395
</simpara></listitem></varlistentry>
399
396
</variablelist><para role="since">Since  2.16
400
397
</para></refsect2>
401
 
<refsect2>
402
 
<title><anchor id="gnome-vfs-uri-ref" role="function"/>gnome_vfs_uri_ref ()</title>
403
 
<indexterm><primary>gnome_vfs_uri_ref</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_ref                   (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
398
<refsect2 id="gnome-vfs-uri-ref" role="function">
 
399
<title>gnome_vfs_uri_ref ()</title>
 
400
<indexterm zone="gnome-vfs-uri-ref"><primary>gnome_vfs_uri_ref</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_ref                   (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
404
401
<para>
405
402
Increment <parameter>uri</parameter>'s reference count.</para>
406
403
<para>
412
409
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <parameter>uri</parameter>.
413
410
</simpara></listitem></varlistentry>
414
411
</variablelist></refsect2>
415
 
<refsect2>
416
 
<title><anchor id="gnome-vfs-uri-unref" role="function"/>gnome_vfs_uri_unref ()</title>
417
 
<indexterm><primary>gnome_vfs_uri_unref</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_unref                 (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
412
<refsect2 id="gnome-vfs-uri-unref" role="function">
 
413
<title>gnome_vfs_uri_unref ()</title>
 
414
<indexterm zone="gnome-vfs-uri-unref"><primary>gnome_vfs_uri_unref</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_unref                 (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
418
415
<para>
419
416
Decrement <parameter>uri</parameter>'s reference count.  If the reference count reaches zero,
420
417
<parameter>uri</parameter> is destroyed.</para>
425
422
<listitem><simpara> a <link linkend="GnomeVFSURI"><type>GnomeVFSURI</type></link>.
426
423
</simpara></listitem></varlistentry>
427
424
</variablelist></refsect2>
428
 
<refsect2>
429
 
<title><anchor id="gnome-vfs-uri-append-string" role="function"/>gnome_vfs_uri_append_string ()</title>
430
 
<indexterm><primary>gnome_vfs_uri_append_string</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_append_string         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
425
<refsect2 id="gnome-vfs-uri-append-string" role="function">
 
426
<title>gnome_vfs_uri_append_string ()</title>
 
427
<indexterm zone="gnome-vfs-uri-append-string"><primary>gnome_vfs_uri_append_string</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_append_string         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
431
428
                                                         const <link linkend="char">char</link> *uri_fragment);</programlisting>
432
429
<para>
433
430
Create a new uri obtained by appending <parameter>uri_fragment</parameter> to <parameter>uri</parameter>.  This will take care
445
442
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new uri obtained by combining <parameter>uri</parameter> and <parameter>uri_fragment</parameter>.
446
443
</simpara></listitem></varlistentry>
447
444
</variablelist></refsect2>
448
 
<refsect2>
449
 
<title><anchor id="gnome-vfs-uri-append-path" role="function"/>gnome_vfs_uri_append_path ()</title>
450
 
<indexterm><primary>gnome_vfs_uri_append_path</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_append_path           (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
445
<refsect2 id="gnome-vfs-uri-append-path" role="function">
 
446
<title>gnome_vfs_uri_append_path ()</title>
 
447
<indexterm zone="gnome-vfs-uri-append-path"><primary>gnome_vfs_uri_append_path</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_append_path           (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
451
448
                                                         const <link linkend="char">char</link> *path);</programlisting>
452
449
<para>
453
450
Create a new uri obtained by appending <parameter>path</parameter> to <parameter>uri</parameter>.  This will take care
465
462
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new uri obtained by combining <parameter>uri</parameter> and <parameter>path</parameter>.
466
463
</simpara></listitem></varlistentry>
467
464
</variablelist></refsect2>
468
 
<refsect2>
469
 
<title><anchor id="gnome-vfs-uri-append-file-name" role="function"/>gnome_vfs_uri_append_file_name ()</title>
470
 
<indexterm><primary>gnome_vfs_uri_append_file_name</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_append_file_name      (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
465
<refsect2 id="gnome-vfs-uri-append-file-name" role="function">
 
466
<title>gnome_vfs_uri_append_file_name ()</title>
 
467
<indexterm zone="gnome-vfs-uri-append-file-name"><primary>gnome_vfs_uri_append_file_name</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_append_file_name      (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
471
468
                                                         const <link linkend="gchar">gchar</link> *filename);</programlisting>
472
469
<para>
473
470
Create a new uri obtained by appending <parameter>file_name</parameter> to <parameter>uri</parameter>.  This will take care
486
483
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new uri obtained by combining <parameter>uri</parameter> and <parameter>path</parameter>.
487
484
</simpara></listitem></varlistentry>
488
485
</variablelist></refsect2>
489
 
<refsect2>
490
 
<title><anchor id="gnome-vfs-uri-to-string" role="function"/>gnome_vfs_uri_to_string ()</title>
491
 
<indexterm><primary>gnome_vfs_uri_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_vfs_uri_to_string             (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
486
<refsect2 id="gnome-vfs-uri-to-string" role="function">
 
487
<title>gnome_vfs_uri_to_string ()</title>
 
488
<indexterm zone="gnome-vfs-uri-to-string"><primary>gnome_vfs_uri_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_vfs_uri_to_string             (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
492
489
                                                         <link linkend="GnomeVFSURIHideOptions">GnomeVFSURIHideOptions</link> hide_options);</programlisting>
493
490
<para>
494
491
Translate <parameter>uri</parameter> into a printable string.  The string will not
518
515
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a malloc'd printable string representing <parameter>uri</parameter>.
519
516
</simpara></listitem></varlistentry>
520
517
</variablelist></refsect2>
521
 
<refsect2>
522
 
<title><anchor id="gnome-vfs-uri-dup" role="function"/>gnome_vfs_uri_dup ()</title>
523
 
<indexterm><primary>gnome_vfs_uri_dup</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_dup                   (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
518
<refsect2 id="gnome-vfs-uri-dup" role="function">
 
519
<title>gnome_vfs_uri_dup ()</title>
 
520
<indexterm zone="gnome-vfs-uri-dup"><primary>gnome_vfs_uri_dup</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_dup                   (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
524
521
<para>
525
522
Duplicate <parameter>uri</parameter>.</para>
526
523
<para>
532
529
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to a new uri that is exactly the same as <parameter>uri</parameter>.
533
530
</simpara></listitem></varlistentry>
534
531
</variablelist></refsect2>
535
 
<refsect2>
536
 
<title><anchor id="gnome-vfs-uri-is-local" role="function"/>gnome_vfs_uri_is_local ()</title>
537
 
<indexterm><primary>gnome_vfs_uri_is_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_is_local              (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
532
<refsect2 id="gnome-vfs-uri-is-local" role="function">
 
533
<title>gnome_vfs_uri_is_local ()</title>
 
534
<indexterm zone="gnome-vfs-uri-is-local"><primary>gnome_vfs_uri_is_local</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_is_local              (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
538
535
<para>
539
536
Check if <parameter>uri</parameter> is a local URI. Note that the return value of this
540
537
function entirely depends on the <link linkend="GnomeVFSMethod"><type>GnomeVFSMethod</type></link> associated with the
552
549
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>uri</parameter> refers to a local entity, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
553
550
</simpara></listitem></varlistentry>
554
551
</variablelist></refsect2>
555
 
<refsect2>
556
 
<title><anchor id="gnome-vfs-uri-has-parent" role="function"/>gnome_vfs_uri_has_parent ()</title>
557
 
<indexterm><primary>gnome_vfs_uri_has_parent</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_has_parent            (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
552
<refsect2 id="gnome-vfs-uri-has-parent" role="function">
 
553
<title>gnome_vfs_uri_has_parent ()</title>
 
554
<indexterm zone="gnome-vfs-uri-has-parent"><primary>gnome_vfs_uri_has_parent</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_has_parent            (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
558
555
<para>
559
556
Check if uri has a parent or not.</para>
560
557
<para>
566
563
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>uri</parameter> has a parent, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
567
564
</simpara></listitem></varlistentry>
568
565
</variablelist></refsect2>
569
 
<refsect2>
570
 
<title><anchor id="gnome-vfs-uri-get-parent" role="function"/>gnome_vfs_uri_get_parent ()</title>
571
 
<indexterm><primary>gnome_vfs_uri_get_parent</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_get_parent            (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
566
<refsect2 id="gnome-vfs-uri-get-parent" role="function">
 
567
<title>gnome_vfs_uri_get_parent ()</title>
 
568
<indexterm zone="gnome-vfs-uri-get-parent"><primary>gnome_vfs_uri_get_parent</primary></indexterm><programlisting><link linkend="GnomeVFSURI">GnomeVFSURI</link>*        gnome_vfs_uri_get_parent            (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
572
569
<para>
573
570
Retrieve <parameter>uri</parameter>'s parent uri.</para>
574
571
<para>
580
577
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to <parameter>uri</parameter>'s parent uri.
581
578
</simpara></listitem></varlistentry>
582
579
</variablelist></refsect2>
583
 
<refsect2>
584
 
<title><anchor id="gnome-vfs-uri-get-toplevel" role="function"/>gnome_vfs_uri_get_toplevel ()</title>
585
 
<indexterm><primary>gnome_vfs_uri_get_toplevel</primary></indexterm><programlisting><link linkend="GnomeVFSToplevelURI">GnomeVFSToplevelURI</link>* gnome_vfs_uri_get_toplevel         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
580
<refsect2 id="gnome-vfs-uri-get-toplevel" role="function">
 
581
<title>gnome_vfs_uri_get_toplevel ()</title>
 
582
<indexterm zone="gnome-vfs-uri-get-toplevel"><primary>gnome_vfs_uri_get_toplevel</primary></indexterm><programlisting><link linkend="GnomeVFSToplevelURI">GnomeVFSToplevelURI</link>* gnome_vfs_uri_get_toplevel         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
586
583
<para>
587
584
Retrieve the toplevel uri in <parameter>uri</parameter>.</para>
588
585
<para>
594
591
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to the toplevel uri object.
595
592
</simpara></listitem></varlistentry>
596
593
</variablelist></refsect2>
597
 
<refsect2>
598
 
<title><anchor id="gnome-vfs-uri-get-host-name" role="function"/>gnome_vfs_uri_get_host_name ()</title>
599
 
<indexterm><primary>gnome_vfs_uri_get_host_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_host_name         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
594
<refsect2 id="gnome-vfs-uri-get-host-name" role="function">
 
595
<title>gnome_vfs_uri_get_host_name ()</title>
 
596
<indexterm zone="gnome-vfs-uri-get-host-name"><primary>gnome_vfs_uri_get_host_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_host_name         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
600
597
<para>
601
598
Retrieve the host name for <parameter>uri</parameter>.</para>
602
599
<para>
608
605
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string representing the host name.
609
606
</simpara></listitem></varlistentry>
610
607
</variablelist></refsect2>
611
 
<refsect2>
612
 
<title><anchor id="gnome-vfs-uri-get-scheme" role="function"/>gnome_vfs_uri_get_scheme ()</title>
613
 
<indexterm><primary>gnome_vfs_uri_get_scheme</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_scheme            (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
608
<refsect2 id="gnome-vfs-uri-get-scheme" role="function">
 
609
<title>gnome_vfs_uri_get_scheme ()</title>
 
610
<indexterm zone="gnome-vfs-uri-get-scheme"><primary>gnome_vfs_uri_get_scheme</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_scheme            (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
614
611
<para>
615
612
Retrieve the scheme used for <parameter>uri</parameter>.</para>
616
613
<para>
622
619
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string representing the scheme.
623
620
</simpara></listitem></varlistentry>
624
621
</variablelist></refsect2>
625
 
<refsect2>
626
 
<title><anchor id="gnome-vfs-uri-get-host-port" role="function"/>gnome_vfs_uri_get_host_port ()</title>
627
 
<indexterm><primary>gnome_vfs_uri_get_host_port</primary></indexterm><programlisting><link linkend="guint">guint</link>               gnome_vfs_uri_get_host_port         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
622
<refsect2 id="gnome-vfs-uri-get-host-port" role="function">
 
623
<title>gnome_vfs_uri_get_host_port ()</title>
 
624
<indexterm zone="gnome-vfs-uri-get-host-port"><primary>gnome_vfs_uri_get_host_port</primary></indexterm><programlisting><link linkend="guint">guint</link>               gnome_vfs_uri_get_host_port         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
628
625
<para>
629
626
Retrieve the host port number in <parameter>uri</parameter>.</para>
630
627
<para>
637
634
default port value for the specified toplevel access method is used.
638
635
</simpara></listitem></varlistentry>
639
636
</variablelist></refsect2>
640
 
<refsect2>
641
 
<title><anchor id="gnome-vfs-uri-get-user-name" role="function"/>gnome_vfs_uri_get_user_name ()</title>
642
 
<indexterm><primary>gnome_vfs_uri_get_user_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_user_name         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
637
<refsect2 id="gnome-vfs-uri-get-user-name" role="function">
 
638
<title>gnome_vfs_uri_get_user_name ()</title>
 
639
<indexterm zone="gnome-vfs-uri-get-user-name"><primary>gnome_vfs_uri_get_user_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_user_name         (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
643
640
<para>
644
641
Retrieve the user name in <parameter>uri</parameter>.</para>
645
642
<para>
651
648
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string representing the user name in <parameter>uri</parameter>.
652
649
</simpara></listitem></varlistentry>
653
650
</variablelist></refsect2>
654
 
<refsect2>
655
 
<title><anchor id="gnome-vfs-uri-get-password" role="function"/>gnome_vfs_uri_get_password ()</title>
656
 
<indexterm><primary>gnome_vfs_uri_get_password</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_password          (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
651
<refsect2 id="gnome-vfs-uri-get-password" role="function">
 
652
<title>gnome_vfs_uri_get_password ()</title>
 
653
<indexterm zone="gnome-vfs-uri-get-password"><primary>gnome_vfs_uri_get_password</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_password          (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
657
654
<para>
658
655
Retrieve the password for <parameter>uri</parameter>.</para>
659
656
<para>
665
662
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The password for <parameter>uri</parameter>.
666
663
</simpara></listitem></varlistentry>
667
664
</variablelist></refsect2>
668
 
<refsect2>
669
 
<title><anchor id="gnome-vfs-uri-set-host-name" role="function"/>gnome_vfs_uri_set_host_name ()</title>
670
 
<indexterm><primary>gnome_vfs_uri_set_host_name</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_set_host_name         (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
665
<refsect2 id="gnome-vfs-uri-set-host-name" role="function">
 
666
<title>gnome_vfs_uri_set_host_name ()</title>
 
667
<indexterm zone="gnome-vfs-uri-set-host-name"><primary>gnome_vfs_uri_set_host_name</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_set_host_name         (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
671
668
                                                         const <link linkend="gchar">gchar</link> *host_name);</programlisting>
672
669
<para>
673
670
Set <parameter>host_name</parameter> as the host name accessed by <parameter>uri</parameter>.</para>
681
678
<listitem><simpara> a string representing a host name.
682
679
</simpara></listitem></varlistentry>
683
680
</variablelist></refsect2>
684
 
<refsect2>
685
 
<title><anchor id="gnome-vfs-uri-set-host-port" role="function"/>gnome_vfs_uri_set_host_port ()</title>
686
 
<indexterm><primary>gnome_vfs_uri_set_host_port</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_set_host_port         (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
681
<refsect2 id="gnome-vfs-uri-set-host-port" role="function">
 
682
<title>gnome_vfs_uri_set_host_port ()</title>
 
683
<indexterm zone="gnome-vfs-uri-set-host-port"><primary>gnome_vfs_uri_set_host_port</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_set_host_port         (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
687
684
                                                         <link linkend="guint">guint</link> host_port);</programlisting>
688
685
<para>
689
686
Set the host port number in <parameter>uri</parameter>.  If <parameter>host_port</parameter> is zero, the default port
698
695
<listitem><simpara> a TCP/IP port number.
699
696
</simpara></listitem></varlistentry>
700
697
</variablelist></refsect2>
701
 
<refsect2>
702
 
<title><anchor id="gnome-vfs-uri-set-user-name" role="function"/>gnome_vfs_uri_set_user_name ()</title>
703
 
<indexterm><primary>gnome_vfs_uri_set_user_name</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_set_user_name         (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
698
<refsect2 id="gnome-vfs-uri-set-user-name" role="function">
 
699
<title>gnome_vfs_uri_set_user_name ()</title>
 
700
<indexterm zone="gnome-vfs-uri-set-user-name"><primary>gnome_vfs_uri_set_user_name</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_set_user_name         (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
704
701
                                                         const <link linkend="gchar">gchar</link> *user_name);</programlisting>
705
702
<para>
706
703
Set <parameter>user_name</parameter> as the user name for <parameter>uri</parameter>.</para>
714
711
<listitem><simpara> a string representing a user name on the host accessed by <parameter>uri</parameter>.
715
712
</simpara></listitem></varlistentry>
716
713
</variablelist></refsect2>
717
 
<refsect2>
718
 
<title><anchor id="gnome-vfs-uri-set-password" role="function"/>gnome_vfs_uri_set_password ()</title>
719
 
<indexterm><primary>gnome_vfs_uri_set_password</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_set_password          (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
714
<refsect2 id="gnome-vfs-uri-set-password" role="function">
 
715
<title>gnome_vfs_uri_set_password ()</title>
 
716
<indexterm zone="gnome-vfs-uri-set-password"><primary>gnome_vfs_uri_set_password</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_set_password          (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
720
717
                                                         const <link linkend="gchar">gchar</link> *password);</programlisting>
721
718
<para>
722
719
Set <parameter>password</parameter> as the password for <parameter>uri</parameter>.</para>
730
727
<listitem><simpara> a password string.
731
728
</simpara></listitem></varlistentry>
732
729
</variablelist></refsect2>
733
 
<refsect2>
734
 
<title><anchor id="gnome-vfs-uri-equal" role="function"/>gnome_vfs_uri_equal ()</title>
735
 
<indexterm><primary>gnome_vfs_uri_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_equal                 (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *a,
 
730
<refsect2 id="gnome-vfs-uri-equal" role="function">
 
731
<title>gnome_vfs_uri_equal ()</title>
 
732
<indexterm zone="gnome-vfs-uri-equal"><primary>gnome_vfs_uri_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_equal                 (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *a,
736
733
                                                         const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *b);</programlisting>
737
734
<para>
738
735
Compare <parameter>a</parameter> and <parameter>b</parameter>.
753
750
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>a</parameter> and <parameter>b</parameter> are equal, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
754
751
</simpara></listitem></varlistentry>
755
752
</variablelist></refsect2>
756
 
<refsect2>
757
 
<title><anchor id="gnome-vfs-uri-is-parent" role="function"/>gnome_vfs_uri_is_parent ()</title>
758
 
<indexterm><primary>gnome_vfs_uri_is_parent</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_is_parent             (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *possible_parent,
 
753
<refsect2 id="gnome-vfs-uri-is-parent" role="function">
 
754
<title>gnome_vfs_uri_is_parent ()</title>
 
755
<indexterm zone="gnome-vfs-uri-is-parent"><primary>gnome_vfs_uri_is_parent</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_is_parent             (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *possible_parent,
759
756
                                                         const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *possible_child,
760
757
                                                         <link linkend="gboolean">gboolean</link> recursive);</programlisting>
761
758
<para>
777
774
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>possible_child</parameter> is contained in  <parameter>possible_parent</parameter>.
778
775
</simpara></listitem></varlistentry>
779
776
</variablelist></refsect2>
780
 
<refsect2>
781
 
<title><anchor id="gnome-vfs-uri-get-path" role="function"/>gnome_vfs_uri_get_path ()</title>
782
 
<indexterm><primary>gnome_vfs_uri_get_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_path              (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
777
<refsect2 id="gnome-vfs-uri-get-path" role="function">
 
778
<title>gnome_vfs_uri_get_path ()</title>
 
779
<indexterm zone="gnome-vfs-uri-get-path"><primary>gnome_vfs_uri_get_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_path              (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
783
780
<para>
784
781
Retrieve full path name for <parameter>uri</parameter>.</para>
785
782
<para>
793
790
be modified nor freed.
794
791
</simpara></listitem></varlistentry>
795
792
</variablelist></refsect2>
796
 
<refsect2>
797
 
<title><anchor id="gnome-vfs-uri-get-fragment-identifier" role="function"/>gnome_vfs_uri_get_fragment_identifier ()</title>
798
 
<indexterm><primary>gnome_vfs_uri_get_fragment_identifier</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_fragment_identifier
 
793
<refsect2 id="gnome-vfs-uri-get-fragment-identifier" role="function">
 
794
<title>gnome_vfs_uri_get_fragment_identifier ()</title>
 
795
<indexterm zone="gnome-vfs-uri-get-fragment-identifier"><primary>gnome_vfs_uri_get_fragment_identifier</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gnome_vfs_uri_get_fragment_identifier
799
796
                                                        (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
800
797
<para>
801
798
 
808
805
 
809
806
</simpara></listitem></varlistentry>
810
807
</variablelist></refsect2>
811
 
<refsect2>
812
 
<title><anchor id="gnome-vfs-uri-extract-dirname" role="function"/>gnome_vfs_uri_extract_dirname ()</title>
813
 
<indexterm><primary>gnome_vfs_uri_extract_dirname</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_vfs_uri_extract_dirname       (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
808
<refsect2 id="gnome-vfs-uri-extract-dirname" role="function">
 
809
<title>gnome_vfs_uri_extract_dirname ()</title>
 
810
<indexterm zone="gnome-vfs-uri-extract-dirname"><primary>gnome_vfs_uri_extract_dirname</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_vfs_uri_extract_dirname       (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
814
811
<para>
815
812
Extract the name of the directory in which the file pointed to by <parameter>uri</parameter> is
816
813
stored as a newly allocated string.  The string will end with a
825
822
parent directory.
826
823
</simpara></listitem></varlistentry>
827
824
</variablelist></refsect2>
828
 
<refsect2>
829
 
<title><anchor id="gnome-vfs-uri-extract-short-name" role="function"/>gnome_vfs_uri_extract_short_name ()</title>
830
 
<indexterm><primary>gnome_vfs_uri_extract_short_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_vfs_uri_extract_short_name    (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
825
<refsect2 id="gnome-vfs-uri-extract-short-name" role="function">
 
826
<title>gnome_vfs_uri_extract_short_name ()</title>
 
827
<indexterm zone="gnome-vfs-uri-extract-short-name"><primary>gnome_vfs_uri_extract_short_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_vfs_uri_extract_short_name    (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
831
828
<para>
832
829
Retrieve base file name for <parameter>uri</parameter>, ignoring any trailing path separators.
833
830
This matches the XPG definition of basename, but not g_basename. This is
848
845
unescaped short form of the name.
849
846
</simpara></listitem></varlistentry>
850
847
</variablelist></refsect2>
851
 
<refsect2>
852
 
<title><anchor id="gnome-vfs-uri-extract-short-path-name" role="function"/>gnome_vfs_uri_extract_short_path_name ()</title>
853
 
<indexterm><primary>gnome_vfs_uri_extract_short_path_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_vfs_uri_extract_short_path_name
 
848
<refsect2 id="gnome-vfs-uri-extract-short-path-name" role="function">
 
849
<title>gnome_vfs_uri_extract_short_path_name ()</title>
 
850
<indexterm zone="gnome-vfs-uri-extract-short-path-name"><primary>gnome_vfs_uri_extract_short_path_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gnome_vfs_uri_extract_short_path_name
854
851
                                                        (const <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
855
852
<para>
856
853
Retrieve base file name for <parameter>uri</parameter>, ignoring any trailing path separators.
872
869
escaped short form of the name.
873
870
</simpara></listitem></varlistentry>
874
871
</variablelist></refsect2>
875
 
<refsect2>
876
 
<title><anchor id="gnome-vfs-uri-hequal" role="function"/>gnome_vfs_uri_hequal ()</title>
877
 
<indexterm><primary>gnome_vfs_uri_hequal</primary></indexterm><programlisting><link linkend="gint">gint</link>                gnome_vfs_uri_hequal                (<link linkend="gconstpointer">gconstpointer</link> a,
 
872
<refsect2 id="gnome-vfs-uri-hequal" role="function">
 
873
<title>gnome_vfs_uri_hequal ()</title>
 
874
<indexterm zone="gnome-vfs-uri-hequal"><primary>gnome_vfs_uri_hequal</primary></indexterm><programlisting><link linkend="gint">gint</link>                gnome_vfs_uri_hequal                (<link linkend="gconstpointer">gconstpointer</link> a,
878
875
                                                         <link linkend="gconstpointer">gconstpointer</link> b);</programlisting>
879
876
<para>
880
877
Function intended for use as a hash table "are these two items
891
888
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the uris are the same.
892
889
</simpara></listitem></varlistentry>
893
890
</variablelist></refsect2>
894
 
<refsect2>
895
 
<title><anchor id="gnome-vfs-uri-hash" role="function"/>gnome_vfs_uri_hash ()</title>
896
 
<indexterm><primary>gnome_vfs_uri_hash</primary></indexterm><programlisting><link linkend="guint">guint</link>               gnome_vfs_uri_hash                  (<link linkend="gconstpointer">gconstpointer</link> p);</programlisting>
 
891
<refsect2 id="gnome-vfs-uri-hash" role="function">
 
892
<title>gnome_vfs_uri_hash ()</title>
 
893
<indexterm zone="gnome-vfs-uri-hash"><primary>gnome_vfs_uri_hash</primary></indexterm><programlisting><link linkend="guint">guint</link>               gnome_vfs_uri_hash                  (<link linkend="gconstpointer">gconstpointer</link> p);</programlisting>
897
894
<para>
898
895
Creates an integer value from a <link linkend="GnomeVFSURI"><type>GnomeVFSURI</type></link>, appropriate
899
896
for using as the key to a hash table entry.</para>
906
903
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a hash key corresponding to <parameter>p</parameter>.
907
904
</simpara></listitem></varlistentry>
908
905
</variablelist></refsect2>
909
 
<refsect2>
910
 
<title><anchor id="gnome-vfs-uri-list-parse" role="function"/>gnome_vfs_uri_list_parse ()</title>
911
 
<indexterm><primary>gnome_vfs_uri_list_parse</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_uri_list_parse            (const <link linkend="gchar">gchar</link> *uri_list);</programlisting>
 
906
<refsect2 id="gnome-vfs-uri-list-parse" role="function">
 
907
<title>gnome_vfs_uri_list_parse ()</title>
 
908
<indexterm zone="gnome-vfs-uri-list-parse"><primary>gnome_vfs_uri_list_parse</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_uri_list_parse            (const <link linkend="gchar">gchar</link> *uri_list);</programlisting>
912
909
<para>
913
910
Extracts a list of <link linkend="GnomeVFSURI"><type>GnomeVFSURI</type></link> objects from a standard text/uri-list,
914
911
such as one you would get on a drop operation.  Use
922
919
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> of <link linkend="GnomeVFSURIs"><type>GnomeVFSURIs</type></link>.
923
920
</simpara></listitem></varlistentry>
924
921
</variablelist></refsect2>
925
 
<refsect2>
926
 
<title><anchor id="gnome-vfs-uri-list-ref" role="function"/>gnome_vfs_uri_list_ref ()</title>
927
 
<indexterm><primary>gnome_vfs_uri_list_ref</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_uri_list_ref              (<link linkend="GList">GList</link> *list);</programlisting>
 
922
<refsect2 id="gnome-vfs-uri-list-ref" role="function">
 
923
<title>gnome_vfs_uri_list_ref ()</title>
 
924
<indexterm zone="gnome-vfs-uri-list-ref"><primary>gnome_vfs_uri_list_ref</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_uri_list_ref              (<link linkend="GList">GList</link> *list);</programlisting>
928
925
<para>
929
926
Increments the reference count of the items in <parameter>list</parameter> by one.</para>
930
927
<para>
936
933
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <parameter>list</parameter>.
937
934
</simpara></listitem></varlistentry>
938
935
</variablelist></refsect2>
939
 
<refsect2>
940
 
<title><anchor id="gnome-vfs-uri-list-unref" role="function"/>gnome_vfs_uri_list_unref ()</title>
941
 
<indexterm><primary>gnome_vfs_uri_list_unref</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_uri_list_unref            (<link linkend="GList">GList</link> *list);</programlisting>
 
936
<refsect2 id="gnome-vfs-uri-list-unref" role="function">
 
937
<title>gnome_vfs_uri_list_unref ()</title>
 
938
<indexterm zone="gnome-vfs-uri-list-unref"><primary>gnome_vfs_uri_list_unref</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_uri_list_unref            (<link linkend="GList">GList</link> *list);</programlisting>
942
939
<para>
943
940
Decrements the reference count of the items in <parameter>list</parameter> by one.
944
941
Note that the list is *not freed* even if each member of the list
952
949
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <parameter>list</parameter>.
953
950
</simpara></listitem></varlistentry>
954
951
</variablelist></refsect2>
955
 
<refsect2>
956
 
<title><anchor id="gnome-vfs-uri-list-copy" role="function"/>gnome_vfs_uri_list_copy ()</title>
957
 
<indexterm><primary>gnome_vfs_uri_list_copy</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_uri_list_copy             (<link linkend="GList">GList</link> *list);</programlisting>
 
952
<refsect2 id="gnome-vfs-uri-list-copy" role="function">
 
953
<title>gnome_vfs_uri_list_copy ()</title>
 
954
<indexterm zone="gnome-vfs-uri-list-copy"><primary>gnome_vfs_uri_list_copy</primary></indexterm><programlisting><link linkend="GList">GList</link>*              gnome_vfs_uri_list_copy             (<link linkend="GList">GList</link> *list);</programlisting>
958
955
<para>
959
956
Creates a duplicate of <parameter>list</parameter>, and references each member of
960
957
that list.</para>
967
964
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly referenced duplicate of <parameter>list</parameter>.
968
965
</simpara></listitem></varlistentry>
969
966
</variablelist></refsect2>
970
 
<refsect2>
971
 
<title><anchor id="gnome-vfs-uri-list-free" role="function"/>gnome_vfs_uri_list_free ()</title>
972
 
<indexterm><primary>gnome_vfs_uri_list_free</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_list_free             (<link linkend="GList">GList</link> *list);</programlisting>
 
967
<refsect2 id="gnome-vfs-uri-list-free" role="function">
 
968
<title>gnome_vfs_uri_list_free ()</title>
 
969
<indexterm zone="gnome-vfs-uri-list-free"><primary>gnome_vfs_uri_list_free</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_vfs_uri_list_free             (<link linkend="GList">GList</link> *list);</programlisting>
973
970
<para>
974
971
Decrements the reference count of each member of <parameter>list</parameter> by one,
975
972
and frees the list itself.</para>
980
977
<listitem><simpara> list of <link linkend="GnomeVFSURI"><type>GnomeVFSURI</type></link> elements.
981
978
</simpara></listitem></varlistentry>
982
979
</variablelist></refsect2>
983
 
<refsect2>
984
 
<title><anchor id="gnome-vfs-uri-make-full-from-relative" role="function"/>gnome_vfs_uri_make_full_from_relative ()</title>
985
 
<indexterm><primary>gnome_vfs_uri_make_full_from_relative</primary></indexterm><programlisting><link linkend="char">char</link>*               gnome_vfs_uri_make_full_from_relative
 
980
<refsect2 id="gnome-vfs-uri-make-full-from-relative" role="function">
 
981
<title>gnome_vfs_uri_make_full_from_relative ()</title>
 
982
<indexterm zone="gnome-vfs-uri-make-full-from-relative"><primary>gnome_vfs_uri_make_full_from_relative</primary></indexterm><programlisting><link linkend="char">char</link>*               gnome_vfs_uri_make_full_from_relative
986
983
                                                        (const <link linkend="char">char</link> *base_uri,
987
984
                                                         const <link linkend="char">char</link> *relative_uri);</programlisting>
988
985
<para>