1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GnomeVFSURI</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
7
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
8
<link rel="up" href="data-types.html" title="Basic Data Types">
9
<link rel="prev" href="gnome-vfs-2.0-gnome-vfs-result.html" title="GnomeVFSResult">
10
<link rel="next" href="gnome-vfs-2.0-gnome-vfs-utils.html" title="gnome-vfs-utils">
11
<meta name="generator" content="GTK-Doc V1.12 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="about.html" title="Introduction to GnomeVFS">
14
<link rel="chapter" href="data-types.html" title="Basic Data Types">
15
<link rel="chapter" href="gnome-vfs-basic-file-ops.html" title="File Operations">
16
<link rel="chapter" href="gnome-vfs-directory-ops.html" title="Directory-Specific Operations">
17
<link rel="chapter" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
18
<link rel="chapter" href="gnome-vfs-file-async-ops.html" title="Asynchronous Operations">
19
<link rel="chapter" href="volumes.html" title="Volumes and Drives Handling">
20
<link rel="chapter" href="networking.html" title="Networking">
21
<link rel="chapter" href="mime-registry.html" title="MIME Registry">
22
<link rel="chapter" href="modules.html" title="Filesystem Modules">
24
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
25
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
27
<td><a accesskey="p" href="gnome-vfs-2.0-gnome-vfs-result.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
28
<td><a accesskey="u" href="data-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
29
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
30
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
31
<td><a accesskey="n" href="gnome-vfs-2.0-gnome-vfs-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
33
<tr><td colspan="5" class="shortcuts">
34
<a href="#gnome-vfs-2.0-gnome-vfs-uri.synopsis" class="shortcut">Top</a>
36
<a href="#gnome-vfs-2.0-gnome-vfs-uri.description" class="shortcut">Description</a>
39
<div class="refentry" lang="en">
40
<a name="gnome-vfs-2.0-gnome-vfs-uri"></a><div class="titlepage"></div>
41
<div class="refnamediv"><table width="100%"><tr>
43
<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-uri.top_of_page"></a>GnomeVFSURI</span></h2>
44
<p>GnomeVFSURI — A uniform resource identifier.</p>
46
<td valign="top" align="right"></td>
48
<div class="refsynopsisdiv">
49
<a name="gnome-vfs-2.0-gnome-vfs-uri.synopsis"></a><h2>Synopsis</h2>
50
<pre class="synopsis">
51
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a>;
52
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSToplevelURI" title="GnomeVFSToplevelURI">GnomeVFSToplevelURI</a>;
53
enum <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURIHideOptions" title="enum GnomeVFSURIHideOptions">GnomeVFSURIHideOptions</a>;
54
#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GNOME-VFS-URI-MAGIC-CHR:CAPS" title="GNOME_VFS_URI_MAGIC_CHR">GNOME_VFS_URI_MAGIC_CHR</a>
55
#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GNOME-VFS-URI-MAGIC-STR:CAPS" title="GNOME_VFS_URI_MAGIC_STR">GNOME_VFS_URI_MAGIC_STR</a>
56
#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GNOME-VFS-URI-PATH-CHR:CAPS" title="GNOME_VFS_URI_PATH_CHR">GNOME_VFS_URI_PATH_CHR</a>
57
#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GNOME-VFS-URI-PATH-STR:CAPS" title="GNOME_VFS_URI_PATH_STR">GNOME_VFS_URI_PATH_STR</a>
58
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-new" title="gnome_vfs_uri_new ()">gnome_vfs_uri_new</a> (const gchar *text_uri);
59
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-resolve-relative" title="gnome_vfs_uri_resolve_relative ()">gnome_vfs_uri_resolve_relative</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *base,
60
const gchar *relative_reference);
61
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-resolve-symbolic-link" title="gnome_vfs_uri_resolve_symbolic_link ()">gnome_vfs_uri_resolve_symbolic_link</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *base,
62
const gchar *relative_reference);
63
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-ref" title="gnome_vfs_uri_ref ()">gnome_vfs_uri_ref</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
64
void <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-unref" title="gnome_vfs_uri_unref ()">gnome_vfs_uri_unref</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
65
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-append-string" title="gnome_vfs_uri_append_string ()">gnome_vfs_uri_append_string</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
66
const char *uri_fragment);
67
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-append-path" title="gnome_vfs_uri_append_path ()">gnome_vfs_uri_append_path</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
69
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-append-file-name" title="gnome_vfs_uri_append_file_name ()">gnome_vfs_uri_append_file_name</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
70
const gchar *filename);
71
gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-to-string" title="gnome_vfs_uri_to_string ()">gnome_vfs_uri_to_string</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
72
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURIHideOptions" title="enum GnomeVFSURIHideOptions">GnomeVFSURIHideOptions</a> hide_options);
73
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-dup" title="gnome_vfs_uri_dup ()">gnome_vfs_uri_dup</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
74
gboolean <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-is-local" title="gnome_vfs_uri_is_local ()">gnome_vfs_uri_is_local</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
75
gboolean <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-has-parent" title="gnome_vfs_uri_has_parent ()">gnome_vfs_uri_has_parent</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
76
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-parent" title="gnome_vfs_uri_get_parent ()">gnome_vfs_uri_get_parent</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
77
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSToplevelURI" title="GnomeVFSToplevelURI">GnomeVFSToplevelURI</a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-toplevel" title="gnome_vfs_uri_get_toplevel ()">gnome_vfs_uri_get_toplevel</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
78
const gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-host-name" title="gnome_vfs_uri_get_host_name ()">gnome_vfs_uri_get_host_name</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
79
const gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-scheme" title="gnome_vfs_uri_get_scheme ()">gnome_vfs_uri_get_scheme</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
80
guint <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-host-port" title="gnome_vfs_uri_get_host_port ()">gnome_vfs_uri_get_host_port</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
81
const gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-user-name" title="gnome_vfs_uri_get_user_name ()">gnome_vfs_uri_get_user_name</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
82
const gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-password" title="gnome_vfs_uri_get_password ()">gnome_vfs_uri_get_password</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
83
void <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-set-host-name" title="gnome_vfs_uri_set_host_name ()">gnome_vfs_uri_set_host_name</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
84
const gchar *host_name);
85
void <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-set-host-port" title="gnome_vfs_uri_set_host_port ()">gnome_vfs_uri_set_host_port</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
87
void <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-set-user-name" title="gnome_vfs_uri_set_user_name ()">gnome_vfs_uri_set_user_name</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
88
const gchar *user_name);
89
void <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-set-password" title="gnome_vfs_uri_set_password ()">gnome_vfs_uri_set_password</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
90
const gchar *password);
91
gboolean <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-equal" title="gnome_vfs_uri_equal ()">gnome_vfs_uri_equal</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *a,
92
const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *b);
93
gboolean <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-is-parent" title="gnome_vfs_uri_is_parent ()">gnome_vfs_uri_is_parent</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *possible_parent,
94
const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *possible_child,
96
const gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-path" title="gnome_vfs_uri_get_path ()">gnome_vfs_uri_get_path</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
97
const gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-get-fragment-identifier" title="gnome_vfs_uri_get_fragment_identifier ()">gnome_vfs_uri_get_fragment_identifier</a>
98
(const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
99
gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-extract-dirname" title="gnome_vfs_uri_extract_dirname ()">gnome_vfs_uri_extract_dirname</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
100
gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-extract-short-name" title="gnome_vfs_uri_extract_short_name ()">gnome_vfs_uri_extract_short_name</a> (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
101
gchar * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-extract-short-path-name" title="gnome_vfs_uri_extract_short_path_name ()">gnome_vfs_uri_extract_short_path_name</a>
102
(const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);
103
gint <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-hequal" title="gnome_vfs_uri_hequal ()">gnome_vfs_uri_hequal</a> (gconstpointer a,
105
guint <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-hash" title="gnome_vfs_uri_hash ()">gnome_vfs_uri_hash</a> (gconstpointer p);
106
GList * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-list-parse" title="gnome_vfs_uri_list_parse ()">gnome_vfs_uri_list_parse</a> (const gchar *uri_list);
107
GList * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-list-ref" title="gnome_vfs_uri_list_ref ()">gnome_vfs_uri_list_ref</a> (GList *list);
108
GList * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-list-unref" title="gnome_vfs_uri_list_unref ()">gnome_vfs_uri_list_unref</a> (GList *list);
109
GList * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-list-copy" title="gnome_vfs_uri_list_copy ()">gnome_vfs_uri_list_copy</a> (GList *list);
110
void <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-list-free" title="gnome_vfs_uri_list_free ()">gnome_vfs_uri_list_free</a> (GList *list);
111
char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-make-full-from-relative" title="gnome_vfs_uri_make_full_from_relative ()">gnome_vfs_uri_make_full_from_relative</a>
112
(const char *base_uri,
113
const char *relative_uri);
116
<div class="refsect1" lang="en">
117
<a name="gnome-vfs-2.0-gnome-vfs-uri.description"></a><h2>Description</h2>
119
A <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> is a semi-textual representation
120
of a uniform resource identifier. It contains the
121
information about a resource location encoded
122
as canononicalized text, but also holds extra
123
information about the context in which the
127
<div class="refsect1" lang="en">
128
<a name="gnome-vfs-2.0-gnome-vfs-uri.details"></a><h2>Details</h2>
129
<div class="refsect2" lang="en">
130
<a name="GnomeVFSURI"></a><h3>GnomeVFSURI</h3>
131
<pre class="programlisting">typedef struct {
137
gchar *method_string;
138
struct GnomeVFSMethod *method;
140
struct GnomeVFSURI *parent;
144
Holds information about the location of a particular resource.</p>
147
<div class="variablelist"><table border="0">
148
<col align="left" valign="top">
151
<td><p><span class="term">guint <em class="structfield"><code><a name="GnomeVFSURI.ref_count"></a>ref_count</code></em>;</span></p></td>
152
<td> Reference count. The URI is freed when it drops to zero.
156
<td><p><span class="term">gchar *<em class="structfield"><code><a name="GnomeVFSURI.text"></a>text</code></em>;</span></p></td>
157
<td> A canonical representation of the path associated with this resource.
161
<td><p><span class="term">gchar *<em class="structfield"><code><a name="GnomeVFSURI.fragment_id"></a>fragment_id</code></em>;</span></p></td>
162
<td> Extra data identifying this resource.
166
<td><p><span class="term">gchar *<em class="structfield"><code><a name="GnomeVFSURI.method_string"></a>method_string</code></em>;</span></p></td>
167
<td> The <em class="parameter"><code>method</code></em>'s method associated with this resource.
168
One <span class="type">GnomeVFSMethod</span> can be used for multiple method strings.
172
<td><p><span class="term">struct GnomeVFSMethod *<em class="structfield"><code><a name="GnomeVFSURI.method"></a>method</code></em>;</span></p></td>
173
<td> The <span class="type">GnomeVFSMethod</span> associated with this resource.
177
<td><p><span class="term">struct <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *<em class="structfield"><code><a name="GnomeVFSURI.parent"></a>parent</code></em>;</span></p></td>
178
<td> Pointer to the parent element, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> that
179
have no enclosing <span class="type">GnomeVFSURI.</span> The process of encapsulating one
180
URI in another one is called URI chaining.
187
<div class="refsect2" lang="en">
188
<a name="GnomeVFSToplevelURI"></a><h3>GnomeVFSToplevelURI</h3>
189
<pre class="programlisting">typedef struct {
199
} GnomeVFSToplevelURI;
202
This is the toplevel URI element used to access ressources stored on
203
a remote server. Toplevel method implementations should cast the <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>
204
argument to this type to get the additional host and authentication information.
207
If any of the elements is 0 respectively <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, it is unspecified.</p>
210
<div class="variablelist"><table border="0">
211
<col align="left" valign="top">
214
<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> <em class="structfield"><code><a name="GnomeVFSToplevelURI.uri"></a>uri</code></em>;</span></p></td>
219
<td><p><span class="term">gchar *<em class="structfield"><code><a name="GnomeVFSToplevelURI.host_name"></a>host_name</code></em>;</span></p></td>
220
<td> The name of the host used to access this resource, o <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.
224
<td><p><span class="term">guint <em class="structfield"><code><a name="GnomeVFSToplevelURI.host_port"></a>host_port</code></em>;</span></p></td>
225
<td> The port used to access this resource, or <code class="literal">0</code>.
229
<td><p><span class="term">gchar *<em class="structfield"><code><a name="GnomeVFSToplevelURI.user_name"></a>user_name</code></em>;</span></p></td>
230
<td> Unescaped user name used to access this resource, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.
234
<td><p><span class="term">gchar *<em class="structfield"><code><a name="GnomeVFSToplevelURI.password"></a>password</code></em>;</span></p></td>
235
<td> Unescaped password used to access this resource, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.
239
<td><p><span class="term">gchar *<em class="structfield"><code><a name="GnomeVFSToplevelURI.urn"></a>urn</code></em>;</span></p></td>
240
<td> The parent URN, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if it doesn't exist.
247
<div class="refsect2" lang="en">
248
<a name="GnomeVFSURIHideOptions"></a><h3>enum GnomeVFSURIHideOptions</h3>
249
<pre class="programlisting">typedef enum
251
GNOME_VFS_URI_HIDE_NONE = 0,
252
GNOME_VFS_URI_HIDE_USER_NAME = 1 << 0,
253
GNOME_VFS_URI_HIDE_PASSWORD = 1 << 1,
254
GNOME_VFS_URI_HIDE_HOST_NAME = 1 << 2,
255
GNOME_VFS_URI_HIDE_HOST_PORT = 1 << 3,
256
GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD = 1 << 4,
257
GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER = 1 << 8
258
} GnomeVFSURIHideOptions;
261
Packed boolean bitfield controlling hiding of various elements
262
of a <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> when it is converted to a string using
263
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-to-string" title="gnome_vfs_uri_to_string ()"><code class="function">gnome_vfs_uri_to_string()</code></a>.</p>
266
<div class="variablelist"><table border="0">
267
<col align="left" valign="top">
270
<td><p><a name="GNOME-VFS-URI-HIDE-NONE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_URI_HIDE_NONE</code></span></p></td>
271
<td> don't hide anything
275
<td><p><a name="GNOME-VFS-URI-HIDE-USER-NAME:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_URI_HIDE_USER_NAME</code></span></p></td>
276
<td> hide the user name
280
<td><p><a name="GNOME-VFS-URI-HIDE-PASSWORD:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_URI_HIDE_PASSWORD</code></span></p></td>
281
<td> hide the password
285
<td><p><a name="GNOME-VFS-URI-HIDE-HOST-NAME:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_URI_HIDE_HOST_NAME</code></span></p></td>
286
<td> hide the host name
290
<td><p><a name="GNOME-VFS-URI-HIDE-HOST-PORT:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_URI_HIDE_HOST_PORT</code></span></p></td>
295
<td><p><a name="GNOME-VFS-URI-HIDE-TOPLEVEL-METHOD:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_URI_HIDE_TOPLEVEL_METHOD</code></span></p></td>
296
<td> hide the method (e.g. http, file)
300
<td><p><a name="GNOME-VFS-URI-HIDE-FRAGMENT-IDENTIFIER:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_URI_HIDE_FRAGMENT_IDENTIFIER</code></span></p></td>
301
<td> hide the fragment identifier
308
<div class="refsect2" lang="en">
309
<a name="GNOME-VFS-URI-MAGIC-CHR:CAPS"></a><h3>GNOME_VFS_URI_MAGIC_CHR</h3>
310
<pre class="programlisting">#define GNOME_VFS_URI_MAGIC_CHR '#'
313
The character used to divide location from
314
extra "arguments" passed to the method.</p>
319
<div class="refsect2" lang="en">
320
<a name="GNOME-VFS-URI-MAGIC-STR:CAPS"></a><h3>GNOME_VFS_URI_MAGIC_STR</h3>
321
<pre class="programlisting">#define GNOME_VFS_URI_MAGIC_STR "#"
324
The character used to divide location from
325
extra "arguments" passed to the method.</p>
330
<div class="refsect2" lang="en">
331
<a name="GNOME-VFS-URI-PATH-CHR:CAPS"></a><h3>GNOME_VFS_URI_PATH_CHR</h3>
332
<pre class="programlisting">#define GNOME_VFS_URI_PATH_CHR '/'
335
Defines the path seperator character.</p>
340
<div class="refsect2" lang="en">
341
<a name="GNOME-VFS-URI-PATH-STR:CAPS"></a><h3>GNOME_VFS_URI_PATH_STR</h3>
342
<pre class="programlisting">#define GNOME_VFS_URI_PATH_STR "/"
345
Defines the path seperator string.</p>
350
<div class="refsect2" lang="en">
351
<a name="gnome-vfs-uri-new"></a><h3>gnome_vfs_uri_new ()</h3>
352
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_new (const gchar *text_uri);</pre>
354
Create a new uri from <em class="parameter"><code>text_uri</code></em>. Unsupported and unsafe methods
355
are not allowed and will result in <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> being returned. URL
356
transforms are allowed.
359
The <em class="parameter"><code>a</code></em> text_uri must be an escaped URI string such as returned by
360
<a class="link" href="gnome-vfs-2.0-gnome-vfs-utils.html#gnome-vfs-get-uri-from-local-path" title="gnome_vfs_get_uri_from_local_path ()"><code class="function">gnome_vfs_get_uri_from_local_path()</code></a>, <a class="link" href="gnome-vfs-2.0-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input" title="gnome_vfs_make_uri_from_input ()"><code class="function">gnome_vfs_make_uri_from_input()</code></a>,
361
or <code class="function">gtk_file_chooser_get_uri()</code>.</p>
364
<div class="variablelist"><table border="0">
365
<col align="left" valign="top">
368
<td><p><span class="term"><em class="parameter"><code>text_uri</code></em> :</span></p></td>
369
<td> an escaped string representing a uri.
373
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
381
<div class="refsect2" lang="en">
382
<a name="gnome-vfs-uri-resolve-relative"></a><h3>gnome_vfs_uri_resolve_relative ()</h3>
383
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_resolve_relative (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *base,
384
const gchar *relative_reference);</pre>
386
Create a new uri from <em class="parameter"><code>relative_reference</code></em>, relative to <em class="parameter"><code>base</code></em>. The resolution
387
algorithm in some aspects follows <a class="ulink" href="http://www.ietf.org/rfc/rfc2396.txt" target="_top">RFC
388
2396</a>, section 5.2, but is not identical due to some extra assumptions GnomeVFS
392
If <em class="parameter"><code>relative_reference</code></em> begins with a valid scheme identifier followed by ':',
393
it is assumed to refer to an absolute URI, and a <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> is created from
394
it using <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-new" title="gnome_vfs_uri_new ()"><code class="function">gnome_vfs_uri_new()</code></a>.
397
Otherwise, depending on its precise syntax, it inherits some aspects of the parent URI,
398
but the parents' fragment and query components are ignored.
401
If <em class="parameter"><code>relative_reference</code></em> begins with "//", it only inherits the <em class="parameter"><code>base</code></em> scheme,
402
if it begins with '/' (i.e. is an absolute path reference), it inherits everything
403
ecxept the <em class="parameter"><code>base</code></em> path. Otherwise, it replaces the part of <em class="parameter"><code>base</code></em> after the last '/'.
407
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
408
<h3 class="title">Note</h3>
409
This function should not be used by application authors unless they expect very
410
distinct semantics. Instead, authors should use <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-append-file-name" title="gnome_vfs_uri_append_file_name ()"><code class="function">gnome_vfs_uri_append_file_name()</code></a>,
411
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-append-path" title="gnome_vfs_uri_append_path ()"><code class="function">gnome_vfs_uri_append_path()</code></a>, <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-append-string" title="gnome_vfs_uri_append_string ()"><code class="function">gnome_vfs_uri_append_string()</code></a> or
412
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-resolve-symbolic-link" title="gnome_vfs_uri_resolve_symbolic_link ()"><code class="function">gnome_vfs_uri_resolve_symbolic_link()</code></a>.
416
<div class="variablelist"><table border="0">
417
<col align="left" valign="top">
420
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
425
<td><p><span class="term"><em class="parameter"><code>relative_reference</code></em> :</span></p></td>
426
<td> a string representing a possibly relative uri reference.
430
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
431
<td> A <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> referring to <em class="parameter"><code>relative_reference</code></em>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
432
if <em class="parameter"><code>relative_reference</code></em> was malformed.
439
<div class="refsect2" lang="en">
440
<a name="gnome-vfs-uri-resolve-symbolic-link"></a><h3>gnome_vfs_uri_resolve_symbolic_link ()</h3>
441
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_resolve_symbolic_link (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *base,
442
const gchar *relative_reference);</pre>
444
Create a new uri from <em class="parameter"><code>symbolic_link</code></em>, relative to <em class="parameter"><code>base</code></em>.
447
If <em class="parameter"><code>symbolic_link</code></em> begins with a '/', it replaces the path of <em class="parameter"><code>base</code></em>,
448
otherwise it is appended after the last '/' character of <em class="parameter"><code>base</code></em>.</p>
451
<div class="variablelist"><table border="0">
452
<col align="left" valign="top">
455
<td><p><span class="term"><em class="parameter"><code>base</code></em> :</span></p></td>
460
<td><p><span class="term"><em class="parameter"><code>relative_reference</code></em> :</span></p></td>
465
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
466
<td> A new <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> referring to <em class="parameter"><code>symbolic_link</code></em>.
472
<p class="since">Since 2.16</p>
475
<div class="refsect2" lang="en">
476
<a name="gnome-vfs-uri-ref"></a><h3>gnome_vfs_uri_ref ()</h3>
477
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_ref (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
479
Increment <em class="parameter"><code>uri</code></em>'s reference count.</p>
482
<div class="variablelist"><table border="0">
483
<col align="left" valign="top">
486
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
487
<td> a <span class="type">GnomeVFSURI.</span>
491
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
492
<td> <em class="parameter"><code>uri</code></em>.
499
<div class="refsect2" lang="en">
500
<a name="gnome-vfs-uri-unref"></a><h3>gnome_vfs_uri_unref ()</h3>
501
<pre class="programlisting">void gnome_vfs_uri_unref (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
503
Decrement <em class="parameter"><code>uri</code></em>'s reference count. If the reference count reaches zero,
504
<em class="parameter"><code>uri</code></em> is destroyed.</p>
507
<div class="variablelist"><table border="0">
508
<col align="left" valign="top">
510
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
511
<td> a <span class="type">GnomeVFSURI.</span>
517
<div class="refsect2" lang="en">
518
<a name="gnome-vfs-uri-append-string"></a><h3>gnome_vfs_uri_append_string ()</h3>
519
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_append_string (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
520
const char *uri_fragment);</pre>
522
Create a new uri obtained by appending <em class="parameter"><code>uri_fragment</code></em> to <em class="parameter"><code>uri</code></em>. This will take care
523
of adding an appropriate directory separator between the end of <em class="parameter"><code>uri</code></em> and
524
the start of <em class="parameter"><code>uri_fragment</code></em> if necessary.</p>
527
<div class="variablelist"><table border="0">
528
<col align="left" valign="top">
531
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
532
<td> a <span class="type">GnomeVFSURI.</span>
536
<td><p><span class="term"><em class="parameter"><code>uri_fragment</code></em> :</span></p></td>
537
<td> a piece of a uri (ie a fully escaped partial path).
541
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
542
<td> The new uri obtained by combining <em class="parameter"><code>uri</code></em> and <em class="parameter"><code>uri_fragment</code></em>.
549
<div class="refsect2" lang="en">
550
<a name="gnome-vfs-uri-append-path"></a><h3>gnome_vfs_uri_append_path ()</h3>
551
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_append_path (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
552
const char *path);</pre>
554
Create a new uri obtained by appending <em class="parameter"><code>path</code></em> to <em class="parameter"><code>uri</code></em>. This will take care
555
of adding an appropriate directory separator between the end of <em class="parameter"><code>uri</code></em> and
556
the start of <em class="parameter"><code>path</code></em> if necessary as well as escaping <em class="parameter"><code>path</code></em> as necessary.</p>
559
<div class="variablelist"><table border="0">
560
<col align="left" valign="top">
563
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
564
<td> a <span class="type">GnomeVFSURI.</span>
568
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
569
<td> a non-escaped file path.
573
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
574
<td> The new uri obtained by combining <em class="parameter"><code>uri</code></em> and <em class="parameter"><code>path</code></em>.
581
<div class="refsect2" lang="en">
582
<a name="gnome-vfs-uri-append-file-name"></a><h3>gnome_vfs_uri_append_file_name ()</h3>
583
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_append_file_name (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
584
const gchar *filename);</pre>
586
Create a new uri obtained by appending <em class="parameter"><code>file_name</code></em> to <em class="parameter"><code>uri</code></em>. This will take care
587
of adding an appropriate directory separator between the end of <em class="parameter"><code>uri</code></em> and
588
the start of <em class="parameter"><code>file_name</code></em> if necessary. <em class="parameter"><code>file_name</code></em> might, for instance, be the
589
result of a call to <code class="function">g_dir_read_name()</code>.</p>
592
<div class="variablelist"><table border="0">
593
<col align="left" valign="top">
596
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
597
<td> a <span class="type">GnomeVFSURI.</span>
601
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
602
<td> any "regular" file name (can include #, /, etc) in the file system encoding. This is not an escaped URI.
606
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
607
<td> The new uri obtained by combining <em class="parameter"><code>uri</code></em> and <em class="parameter"><code>path</code></em>.
614
<div class="refsect2" lang="en">
615
<a name="gnome-vfs-uri-to-string"></a><h3>gnome_vfs_uri_to_string ()</h3>
616
<pre class="programlisting">gchar * gnome_vfs_uri_to_string (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
617
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURIHideOptions" title="enum GnomeVFSURIHideOptions">GnomeVFSURIHideOptions</a> hide_options);</pre>
619
Translate <em class="parameter"><code>uri</code></em> into a printable string. The string will not
620
contain the uri elements specified by <em class="parameter"><code>hide_options</code></em>.
623
A file: URI on Win32 might look like file:///x:/foo/bar.txt. Note
624
that the part after file:// is not a legal file name, you need to
625
remove the / in front of the drive letter. This function does that
626
automatically if <em class="parameter"><code>hide_options</code></em> specifies that the toplevel method,
627
user name, password, host name and host port should be hidden.
630
On the other hand, a file: URI for a UNC path looks like
631
file:////server/share/foo/bar.txt, and in that case the part after
632
file:// is the correct file name.</p>
635
<div class="variablelist"><table border="0">
636
<col align="left" valign="top">
639
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
640
<td> a <span class="type">GnomeVFSURI.</span>
644
<td><p><span class="term"><em class="parameter"><code>hide_options</code></em> :</span></p></td>
645
<td> bitmask specifying what uri elements (e.g. password,
646
user name etc.) should not be represented in the returned string.
650
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
651
<td> a malloc'd printable string representing <em class="parameter"><code>uri</code></em>.
658
<div class="refsect2" lang="en">
659
<a name="gnome-vfs-uri-dup"></a><h3>gnome_vfs_uri_dup ()</h3>
660
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_dup (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
662
Duplicate <em class="parameter"><code>uri</code></em>.</p>
665
<div class="variablelist"><table border="0">
666
<col align="left" valign="top">
669
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
670
<td> a <span class="type">GnomeVFSURI.</span>
674
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
675
<td> a pointer to a new uri that is exactly the same as <em class="parameter"><code>uri</code></em>.
682
<div class="refsect2" lang="en">
683
<a name="gnome-vfs-uri-is-local"></a><h3>gnome_vfs_uri_is_local ()</h3>
684
<pre class="programlisting">gboolean gnome_vfs_uri_is_local (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
686
Check if <em class="parameter"><code>uri</code></em> is a local URI. Note that the return value of this
687
function entirely depends on the <span class="type">GnomeVFSMethod</span> associated with the
688
URI. It is up to the method author to distinguish between remote URIs
689
add URIs referring to entities on the local computer.
692
Warning, this can be slow, as it does i/o to detect things like NFS mounts.</p>
695
<div class="variablelist"><table border="0">
696
<col align="left" valign="top">
699
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
700
<td> a <span class="type">GnomeVFSURI.</span>
704
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
705
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> refers to a local entity, <code class="literal">FALSE</code> otherwise.
712
<div class="refsect2" lang="en">
713
<a name="gnome-vfs-uri-has-parent"></a><h3>gnome_vfs_uri_has_parent ()</h3>
714
<pre class="programlisting">gboolean gnome_vfs_uri_has_parent (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
716
Check if uri has a parent or not.</p>
719
<div class="variablelist"><table border="0">
720
<col align="left" valign="top">
723
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
724
<td> a <span class="type">GnomeVFSURI.</span>
728
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
729
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> has a parent, <code class="literal">FALSE</code> otherwise.
736
<div class="refsect2" lang="en">
737
<a name="gnome-vfs-uri-get-parent"></a><h3>gnome_vfs_uri_get_parent ()</h3>
738
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> * gnome_vfs_uri_get_parent (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
740
Retrieve <em class="parameter"><code>uri</code></em>'s parent uri.</p>
743
<div class="variablelist"><table border="0">
744
<col align="left" valign="top">
747
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
748
<td> a <span class="type">GnomeVFSURI.</span>
752
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
753
<td> a pointer to <em class="parameter"><code>uri</code></em>'s parent uri.
760
<div class="refsect2" lang="en">
761
<a name="gnome-vfs-uri-get-toplevel"></a><h3>gnome_vfs_uri_get_toplevel ()</h3>
762
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSToplevelURI" title="GnomeVFSToplevelURI">GnomeVFSToplevelURI</a> * gnome_vfs_uri_get_toplevel (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
764
Retrieve the toplevel uri in <em class="parameter"><code>uri</code></em>.</p>
767
<div class="variablelist"><table border="0">
768
<col align="left" valign="top">
771
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
772
<td> a <span class="type">GnomeVFSURI.</span>
776
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
777
<td> a pointer to the toplevel uri object.
784
<div class="refsect2" lang="en">
785
<a name="gnome-vfs-uri-get-host-name"></a><h3>gnome_vfs_uri_get_host_name ()</h3>
786
<pre class="programlisting">const gchar * gnome_vfs_uri_get_host_name (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
788
Retrieve the host name for <em class="parameter"><code>uri</code></em>.</p>
791
<div class="variablelist"><table border="0">
792
<col align="left" valign="top">
795
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
796
<td> a <span class="type">GnomeVFSURI.</span>
800
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
801
<td> a string representing the host name.
808
<div class="refsect2" lang="en">
809
<a name="gnome-vfs-uri-get-scheme"></a><h3>gnome_vfs_uri_get_scheme ()</h3>
810
<pre class="programlisting">const gchar * gnome_vfs_uri_get_scheme (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
812
Retrieve the scheme used for <em class="parameter"><code>uri</code></em>.</p>
815
<div class="variablelist"><table border="0">
816
<col align="left" valign="top">
819
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
820
<td> a <span class="type">GnomeVFSURI.</span>
824
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
825
<td> a string representing the scheme.
832
<div class="refsect2" lang="en">
833
<a name="gnome-vfs-uri-get-host-port"></a><h3>gnome_vfs_uri_get_host_port ()</h3>
834
<pre class="programlisting">guint gnome_vfs_uri_get_host_port (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
836
Retrieve the host port number in <em class="parameter"><code>uri</code></em>.</p>
839
<div class="variablelist"><table border="0">
840
<col align="left" valign="top">
843
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
844
<td> a <span class="type">GnomeVFSURI.</span>
848
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
849
<td> The host port number used by <em class="parameter"><code>uri</code></em>. If the value is zero, the
850
default port value for the specified toplevel access method is used.
857
<div class="refsect2" lang="en">
858
<a name="gnome-vfs-uri-get-user-name"></a><h3>gnome_vfs_uri_get_user_name ()</h3>
859
<pre class="programlisting">const gchar * gnome_vfs_uri_get_user_name (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
861
Retrieve the user name in <em class="parameter"><code>uri</code></em>.</p>
864
<div class="variablelist"><table border="0">
865
<col align="left" valign="top">
868
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
869
<td> a <span class="type">GnomeVFSURI.</span>
873
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
874
<td> a string representing the user name in <em class="parameter"><code>uri</code></em>.
881
<div class="refsect2" lang="en">
882
<a name="gnome-vfs-uri-get-password"></a><h3>gnome_vfs_uri_get_password ()</h3>
883
<pre class="programlisting">const gchar * gnome_vfs_uri_get_password (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
885
Retrieve the password for <em class="parameter"><code>uri</code></em>.</p>
888
<div class="variablelist"><table border="0">
889
<col align="left" valign="top">
892
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
893
<td> a <span class="type">GnomeVFSURI.</span>
897
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
898
<td> The password for <em class="parameter"><code>uri</code></em>.
905
<div class="refsect2" lang="en">
906
<a name="gnome-vfs-uri-set-host-name"></a><h3>gnome_vfs_uri_set_host_name ()</h3>
907
<pre class="programlisting">void gnome_vfs_uri_set_host_name (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
908
const gchar *host_name);</pre>
910
Set <em class="parameter"><code>host_name</code></em> as the host name accessed by <em class="parameter"><code>uri</code></em>.</p>
913
<div class="variablelist"><table border="0">
914
<col align="left" valign="top">
917
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
918
<td> a <span class="type">GnomeVFSURI.</span>
922
<td><p><span class="term"><em class="parameter"><code>host_name</code></em> :</span></p></td>
923
<td> a string representing a host name.
930
<div class="refsect2" lang="en">
931
<a name="gnome-vfs-uri-set-host-port"></a><h3>gnome_vfs_uri_set_host_port ()</h3>
932
<pre class="programlisting">void gnome_vfs_uri_set_host_port (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
933
guint host_port);</pre>
935
Set the host port number in <em class="parameter"><code>uri</code></em>. If <em class="parameter"><code>host_port</code></em> is zero, the default port
936
for <em class="parameter"><code>uri</code></em>'s toplevel access method is used.</p>
939
<div class="variablelist"><table border="0">
940
<col align="left" valign="top">
943
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
944
<td> a <span class="type">GnomeVFSURI.</span>
948
<td><p><span class="term"><em class="parameter"><code>host_port</code></em> :</span></p></td>
949
<td> a TCP/IP port number.
956
<div class="refsect2" lang="en">
957
<a name="gnome-vfs-uri-set-user-name"></a><h3>gnome_vfs_uri_set_user_name ()</h3>
958
<pre class="programlisting">void gnome_vfs_uri_set_user_name (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
959
const gchar *user_name);</pre>
961
Set <em class="parameter"><code>user_name</code></em> as the user name for <em class="parameter"><code>uri</code></em>.</p>
964
<div class="variablelist"><table border="0">
965
<col align="left" valign="top">
968
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
969
<td> a <span class="type">GnomeVFSURI.</span>
973
<td><p><span class="term"><em class="parameter"><code>user_name</code></em> :</span></p></td>
974
<td> a string representing a user name on the host accessed by <em class="parameter"><code>uri</code></em>.
981
<div class="refsect2" lang="en">
982
<a name="gnome-vfs-uri-set-password"></a><h3>gnome_vfs_uri_set_password ()</h3>
983
<pre class="programlisting">void gnome_vfs_uri_set_password (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri,
984
const gchar *password);</pre>
986
Set <em class="parameter"><code>password</code></em> as the password for <em class="parameter"><code>uri</code></em>.</p>
989
<div class="variablelist"><table border="0">
990
<col align="left" valign="top">
993
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
994
<td> a <span class="type">GnomeVFSURI.</span>
998
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
999
<td> a password string.
1006
<div class="refsect2" lang="en">
1007
<a name="gnome-vfs-uri-equal"></a><h3>gnome_vfs_uri_equal ()</h3>
1008
<pre class="programlisting">gboolean gnome_vfs_uri_equal (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *a,
1009
const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *b);</pre>
1011
Compare <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em>.
1014
FIXME: This comparison should take into account the possiblity
1015
that unreserved characters may be escaped.
1016
...or perhaps <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-new" title="gnome_vfs_uri_new ()"><code class="function">gnome_vfs_uri_new()</code></a> should unescape unreserved characters?</p>
1019
<div class="variablelist"><table border="0">
1020
<col align="left" valign="top">
1023
<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
1024
<td> a <span class="type">GnomeVFSURI.</span>
1028
<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
1029
<td> a <span class="type">GnomeVFSURI.</span>
1033
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1034
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are equal, <code class="literal">FALSE</code> otherwise.
1041
<div class="refsect2" lang="en">
1042
<a name="gnome-vfs-uri-is-parent"></a><h3>gnome_vfs_uri_is_parent ()</h3>
1043
<pre class="programlisting">gboolean gnome_vfs_uri_is_parent (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *possible_parent,
1044
const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *possible_child,
1045
gboolean recursive);</pre>
1047
Check if <em class="parameter"><code>possible_child</code></em> is contained by <em class="parameter"><code>possible_parent</code></em>.
1048
If <em class="parameter"><code>recursive</code></em> is <code class="literal">FALSE</code>, just try the immediate parent directory, else
1049
search up through the hierarchy.</p>
1052
<div class="variablelist"><table border="0">
1053
<col align="left" valign="top">
1056
<td><p><span class="term"><em class="parameter"><code>possible_parent</code></em> :</span></p></td>
1057
<td> a <span class="type">GnomeVFSURI.</span>
1061
<td><p><span class="term"><em class="parameter"><code>possible_child</code></em> :</span></p></td>
1062
<td> a <span class="type">GnomeVFSURI.</span>
1066
<td><p><span class="term"><em class="parameter"><code>recursive</code></em> :</span></p></td>
1067
<td> a flag to turn recursive check on.
1071
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1072
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>possible_child</code></em> is contained in <em class="parameter"><code>possible_parent</code></em>.
1079
<div class="refsect2" lang="en">
1080
<a name="gnome-vfs-uri-get-path"></a><h3>gnome_vfs_uri_get_path ()</h3>
1081
<pre class="programlisting">const gchar * gnome_vfs_uri_get_path (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
1083
Retrieve full path name for <em class="parameter"><code>uri</code></em>.</p>
1086
<div class="variablelist"><table border="0">
1087
<col align="left" valign="top">
1090
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
1091
<td> a <span class="type">GnomeVFSURI.</span>
1095
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1096
<td> a pointer to the full path name in <em class="parameter"><code>uri</code></em>. Notice that the
1097
pointer points to the path name stored in <em class="parameter"><code>uri</code></em>, so the path name returned must not
1098
be modified nor freed.
1105
<div class="refsect2" lang="en">
1106
<a name="gnome-vfs-uri-get-fragment-identifier"></a><h3>gnome_vfs_uri_get_fragment_identifier ()</h3>
1107
<pre class="programlisting">const gchar * gnome_vfs_uri_get_fragment_identifier
1108
(const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
1111
<div class="variablelist"><table border="0">
1112
<col align="left" valign="top">
1115
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
1120
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1128
<div class="refsect2" lang="en">
1129
<a name="gnome-vfs-uri-extract-dirname"></a><h3>gnome_vfs_uri_extract_dirname ()</h3>
1130
<pre class="programlisting">gchar * gnome_vfs_uri_extract_dirname (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
1132
Extract the name of the directory in which the file pointed to by <em class="parameter"><code>uri</code></em> is
1133
stored as a newly allocated string. The string will end with a
1134
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GNOME-VFS-URI-PATH-CHR:CAPS" title="GNOME_VFS_URI_PATH_CHR"><code class="literal">GNOME_VFS_URI_PATH_CHR</code></a>.</p>
1137
<div class="variablelist"><table border="0">
1138
<col align="left" valign="top">
1141
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
1142
<td> a <span class="type">GnomeVFSURI.</span>
1146
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1147
<td> a pointer to the newly allocated string representing the
1155
<div class="refsect2" lang="en">
1156
<a name="gnome-vfs-uri-extract-short-name"></a><h3>gnome_vfs_uri_extract_short_name ()</h3>
1157
<pre class="programlisting">gchar * gnome_vfs_uri_extract_short_name (const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
1159
Retrieve base file name for <em class="parameter"><code>uri</code></em>, ignoring any trailing path separators.
1160
This matches the XPG definition of basename, but not g_basename. This is
1161
often useful when you want the name of something that's pointed to by a
1162
uri, and don't care whether the uri has a directory or file form.
1163
If <em class="parameter"><code>uri</code></em> points to the root of a domain, returns the host name. If there's
1164
no host name, returns <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GNOME-VFS-URI-PATH-STR:CAPS" title="GNOME_VFS_URI_PATH_STR"><code class="literal">GNOME_VFS_URI_PATH_STR</code></a>.
1167
See also: <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-extract-short-path-name" title="gnome_vfs_uri_extract_short_path_name ()"><code class="function">gnome_vfs_uri_extract_short_path_name()</code></a>.</p>
1170
<div class="variablelist"><table border="0">
1171
<col align="left" valign="top">
1174
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
1175
<td> a <span class="type">GnomeVFSURI.</span>
1179
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1180
<td> a pointer to the newly allocated string representing the
1181
unescaped short form of the name.
1188
<div class="refsect2" lang="en">
1189
<a name="gnome-vfs-uri-extract-short-path-name"></a><h3>gnome_vfs_uri_extract_short_path_name ()</h3>
1190
<pre class="programlisting">gchar * gnome_vfs_uri_extract_short_path_name
1191
(const <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>
1193
Retrieve base file name for <em class="parameter"><code>uri</code></em>, ignoring any trailing path separators.
1194
This matches the XPG definition of basename, but not g_basename. This is
1195
often useful when you want the name of something that's pointed to by a
1196
uri, and don't care whether the uri has a directory or file form.
1197
If <em class="parameter"><code>uri</code></em> points to the root (including the root of any domain),
1198
returns <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GNOME-VFS-URI-PATH-STR:CAPS" title="GNOME_VFS_URI_PATH_STR"><code class="literal">GNOME_VFS_URI_PATH_STR</code></a>.
1201
See also: <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-extract-short-name" title="gnome_vfs_uri_extract_short_name ()"><code class="function">gnome_vfs_uri_extract_short_name()</code></a>.</p>
1204
<div class="variablelist"><table border="0">
1205
<col align="left" valign="top">
1208
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
1209
<td> a <span class="type">GnomeVFSURI.</span>
1213
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1214
<td> a pointer to the newly allocated string representing the
1215
escaped short form of the name.
1222
<div class="refsect2" lang="en">
1223
<a name="gnome-vfs-uri-hequal"></a><h3>gnome_vfs_uri_hequal ()</h3>
1224
<pre class="programlisting">gint gnome_vfs_uri_hequal (gconstpointer a,
1225
gconstpointer b);</pre>
1227
Function intended for use as a hash table "are these two items
1228
the same" comparison. Useful for creating a hash table of uris.</p>
1231
<div class="variablelist"><table border="0">
1232
<col align="left" valign="top">
1235
<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
1236
<td> a pointer to a <span class="type">GnomeVFSURI.</span>
1240
<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
1241
<td> a pointer to a <span class="type">GnomeVFSURI.</span>
1245
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1246
<td> <code class="literal">TRUE</code> if the uris are the same.
1253
<div class="refsect2" lang="en">
1254
<a name="gnome-vfs-uri-hash"></a><h3>gnome_vfs_uri_hash ()</h3>
1255
<pre class="programlisting">guint gnome_vfs_uri_hash (gconstpointer p);</pre>
1257
Creates an integer value from a <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>, appropriate
1258
for using as the key to a hash table entry.</p>
1261
<div class="variablelist"><table border="0">
1262
<col align="left" valign="top">
1265
<td><p><span class="term"><em class="parameter"><code>p</code></em> :</span></p></td>
1266
<td> a pointer to a <span class="type">GnomeVFSURI.</span>
1270
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1271
<td> a hash key corresponding to <em class="parameter"><code>p</code></em>.
1278
<div class="refsect2" lang="en">
1279
<a name="gnome-vfs-uri-list-parse"></a><h3>gnome_vfs_uri_list_parse ()</h3>
1280
<pre class="programlisting">GList * gnome_vfs_uri_list_parse (const gchar *uri_list);</pre>
1282
Extracts a list of <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> objects from a standard text/uri-list,
1283
such as one you would get on a drop operation. Use
1284
<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-list-free" title="gnome_vfs_uri_list_free ()"><code class="function">gnome_vfs_uri_list_free()</code></a> when you are done with the list.</p>
1287
<div class="variablelist"><table border="0">
1288
<col align="left" valign="top">
1291
<td><p><span class="term"><em class="parameter"><code>uri_list</code></em> :</span></p></td>
1292
<td> string consists of <span class="type">GnomeVFSURIs</span> and/or paths seperated by newline character.
1296
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1297
<td> a <span class="type">GList</span> of <span class="type">GnomeVFSURIs.</span>
1304
<div class="refsect2" lang="en">
1305
<a name="gnome-vfs-uri-list-ref"></a><h3>gnome_vfs_uri_list_ref ()</h3>
1306
<pre class="programlisting">GList * gnome_vfs_uri_list_ref (GList *list);</pre>
1308
Increments the reference count of the items in <em class="parameter"><code>list</code></em> by one.</p>
1311
<div class="variablelist"><table border="0">
1312
<col align="left" valign="top">
1315
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1316
<td> list of <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> elements.
1320
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1321
<td> <em class="parameter"><code>list</code></em>.
1328
<div class="refsect2" lang="en">
1329
<a name="gnome-vfs-uri-list-unref"></a><h3>gnome_vfs_uri_list_unref ()</h3>
1330
<pre class="programlisting">GList * gnome_vfs_uri_list_unref (GList *list);</pre>
1332
Decrements the reference count of the items in <em class="parameter"><code>list</code></em> by one.
1333
Note that the list is *not freed* even if each member of the list
1337
<div class="variablelist"><table border="0">
1338
<col align="left" valign="top">
1341
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1342
<td> list of <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> elements.
1346
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1347
<td> <em class="parameter"><code>list</code></em>.
1354
<div class="refsect2" lang="en">
1355
<a name="gnome-vfs-uri-list-copy"></a><h3>gnome_vfs_uri_list_copy ()</h3>
1356
<pre class="programlisting">GList * gnome_vfs_uri_list_copy (GList *list);</pre>
1358
Creates a duplicate of <em class="parameter"><code>list</code></em>, and references each member of
1362
<div class="variablelist"><table border="0">
1363
<col align="left" valign="top">
1366
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1367
<td> list of <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> elements.
1371
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1372
<td> a newly referenced duplicate of <em class="parameter"><code>list</code></em>.
1379
<div class="refsect2" lang="en">
1380
<a name="gnome-vfs-uri-list-free"></a><h3>gnome_vfs_uri_list_free ()</h3>
1381
<pre class="programlisting">void gnome_vfs_uri_list_free (GList *list);</pre>
1383
Decrements the reference count of each member of <em class="parameter"><code>list</code></em> by one,
1384
and frees the list itself.</p>
1387
<div class="variablelist"><table border="0">
1388
<col align="left" valign="top">
1390
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1391
<td> list of <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> elements.
1397
<div class="refsect2" lang="en">
1398
<a name="gnome-vfs-uri-make-full-from-relative"></a><h3>gnome_vfs_uri_make_full_from_relative ()</h3>
1399
<pre class="programlisting">char * gnome_vfs_uri_make_full_from_relative
1400
(const char *base_uri,
1401
const char *relative_uri);</pre>
1403
Returns a full uri given a full base uri, and a secondary uri which may
1407
<div class="variablelist"><table border="0">
1408
<col align="left" valign="top">
1411
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td>
1412
<td> a string representing the base uri.
1416
<td><p><span class="term"><em class="parameter"><code>relative_uri</code></em> :</span></p></td>
1417
<td> a uri fragment/reference to be appended to <em class="parameter"><code>base_uri</code></em>.
1421
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1422
<td> a newly allocated string containing the uri
1423
(<a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for some bad errors).
1431
<div class="footer">
1433
Generated by GTK-Doc V1.12</div>