~adam-stokes/ubuntu/quantal/gnome-vfs/lp977940-multiarch
» Revision
12
: doc/html/gnome-vfs-20-gnome-vfs-utils.html
« back to all changes in this revision
Viewing changes to doc/html/gnome-vfs-20-gnome-vfs-utils.html
- browse files at revision 12
- compare with another revision
- download diff
- download tarball
- view history from revision 12
- 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
- Sync xdgmime with GIO
* debian/patches/90_from_svn_no_range_for_youtube.patch:
- the change is in the new version
- files added:
- doc/tmpl/gnome-vfs-resolve.sgml
- files removed:
- compile
- files modified:
- ChangeLog
added
removed
doc/html/gnome-vfs-20-gnome-vfs-utils.html
1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html>
3
3
<head>
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>gnome-vfs-utils</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
<link rel="start" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
8
8
<link rel="up" href="data-types.html" title="Basic Data Types">
9
9
<link rel="prev" href="gnome-vfs-20-gnome-vfs-uri.html" title="GnomeVFSURI">
10
10
<link rel="next" href="gnome-vfs-20-gnome-vfs-file-info.html" title="GnomeVFSFileInfo">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="about.html" title="Introduction to GnomeVFS">
14
14
<link rel="chapter" href="data-types.html" title="Basic Data Types">
30
30
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
31
31
<td><a accesskey="n" href="gnome-vfs-20-gnome-vfs-file-info.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
32
32
</tr>
33
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2574382" class="shortcut">Top</a>
34
 | 
35
<a href="#id2575197" class="shortcut">Description</a></nobr></td></tr>
33
<tr><td colspan="5" class="shortcuts"><nobr><a href="#gnome-vfs-20-gnome-vfs-utils.synopsis" class="shortcut">Top</a>
34
|
35
<a href="#gnome-vfs-20-gnome-vfs-utils.description" class="shortcut">Description</a></nobr></td></tr>
36
36
</table>
37
37
<div class="refentry" lang="en">
38
38
<a name="gnome-vfs-20-gnome-vfs-utils"></a><div class="titlepage"></div>
39
39
<div class="refnamediv"><table width="100%"><tr>
40
40
<td valign="top">
41
<h2>
42
<a name="id2574382"></a><span class="refentrytitle">gnome-vfs-utils</span>
43
</h2>
44
<p>gnome-vfs-utils — various utilities functions to manipulate uris</p>
41
<h2><span class="refentrytitle"><a name="gnome-vfs-20-gnome-vfs-utils.top_of_page"></a>gnome-vfs-utils</span></h2>
42
<p>gnome-vfs-utils — various utilities functions to manipulate uris</p>
45
43
</td>
46
44
<td valign="top" align="right"></td>
47
45
</tr></table></div>
48
46
<div class="refsynopsisdiv">
49
<h2>Synopsis</h2>
47
<a name="gnome-vfs-20-gnome-vfs-utils.synopsis"></a><h2>Synopsis</h2>
50
48
<pre class="synopsis">
51
52
53
54
enum <a href="gnome-vfs-20-gnome-vfs-utils.html#GnomeVFSMakeURIDirs">GnomeVFSMakeURIDirs</a>;
55
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-format-file-size-for-display">gnome_vfs_format_file_size_for_display</a>
56
(<a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> size);
57
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-format-uri-for-display">gnome_vfs_format_uri_for_display</a> (const char *uri);
58
<a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-url-show">gnome_vfs_url_show</a> (const char *url);
59
<a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-url-show-with-env">gnome_vfs_url_show_with_env</a> (const char *url,
49
enum <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#GnomeVFSMakeURIDirs" title="enum GnomeVFSMakeURIDirs">GnomeVFSMakeURIDirs</a>;
50
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-format-file-size-for-display" title="gnome_vfs_format_file_size_for_display ()">gnome_vfs_format_file_size_for_display</a>
51
(<a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> size);
52
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-format-uri-for-display" title="gnome_vfs_format_uri_for_display ()">gnome_vfs_format_uri_for_display</a> (const char *uri);
53
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-url-show" title="gnome_vfs_url_show ()">gnome_vfs_url_show</a> (const char *url);
54
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-url-show-with-env" title="gnome_vfs_url_show_with_env ()">gnome_vfs_url_show_with_env</a> (const char *url,
60
55
char **envp);
61
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-string">gnome_vfs_escape_string</a> (const char *string);
62
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-path-string">gnome_vfs_escape_path_string</a> (const char *path);
63
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-host-and-path-string">gnome_vfs_escape_host_and_path_string</a>
56
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-string" title="gnome_vfs_escape_string ()">gnome_vfs_escape_string</a> (const char *string);
57
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-path-string" title="gnome_vfs_escape_path_string ()">gnome_vfs_escape_path_string</a> (const char *path);
58
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-host-and-path-string" title="gnome_vfs_escape_host_and_path_string ()">gnome_vfs_escape_host_and_path_string</a>
64
59
(const char *path);
65
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-slashes">gnome_vfs_escape_slashes</a> (const char *string);
66
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-set">gnome_vfs_escape_set</a> (const char *string,
60
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-slashes" title="gnome_vfs_escape_slashes ()">gnome_vfs_escape_slashes</a> (const char *string);
61
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-escape-set" title="gnome_vfs_escape_set ()">gnome_vfs_escape_set</a> (const char *string,
67
62
const char *match_set);
68
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-unescape-string">gnome_vfs_unescape_string</a> (const char *escaped_string,
63
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-unescape-string" title="gnome_vfs_unescape_string ()">gnome_vfs_unescape_string</a> (const char *escaped_string,
69
64
const char *illegal_characters);
70
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-canonical">gnome_vfs_make_uri_canonical</a> (const char *uri);
71
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-canonical-strip-fragment">gnome_vfs_make_uri_canonical_strip_fragment</a>
65
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-canonical" title="gnome_vfs_make_uri_canonical ()">gnome_vfs_make_uri_canonical</a> (const char *uri);
66
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-canonical-strip-fragment" title="gnome_vfs_make_uri_canonical_strip_fragment ()">gnome_vfs_make_uri_canonical_strip_fragment</a>
72
67
(const char *uri);
73
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-path-name-canonical">gnome_vfs_make_path_name_canonical</a> (const char *path);
74
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input">gnome_vfs_make_uri_from_input</a> (const char *location);
75
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input-with-dirs">gnome_vfs_make_uri_from_input_with_dirs</a>
68
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-path-name-canonical" title="gnome_vfs_make_path_name_canonical ()">gnome_vfs_make_path_name_canonical</a> (const char *path);
69
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input" title="gnome_vfs_make_uri_from_input ()">gnome_vfs_make_uri_from_input</a> (const char *location);
70
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input-with-dirs" title="gnome_vfs_make_uri_from_input_with_dirs ()">gnome_vfs_make_uri_from_input_with_dirs</a>
76
71
(const char *location,
77
<a href="gnome-vfs-20-gnome-vfs-utils.html#GnomeVFSMakeURIDirs">GnomeVFSMakeURIDirs</a> dirs);
78
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-shell-arg">gnome_vfs_make_uri_from_shell_arg</a> (const char *uri);
79
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-full-from-relative">gnome_vfs_make_uri_full_from_relative</a>
72
<a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#GnomeVFSMakeURIDirs" title="enum GnomeVFSMakeURIDirs">GnomeVFSMakeURIDirs</a> dirs);
73
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-shell-arg" title="gnome_vfs_make_uri_from_shell_arg ()">gnome_vfs_make_uri_from_shell_arg</a> (const char *uri);
74
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-full-from-relative" title="gnome_vfs_make_uri_full_from_relative ()">gnome_vfs_make_uri_full_from_relative</a>
80
75
(const char *base_uri,
81
76
const char *relative_uri);
82
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-expand-initial-tilde">gnome_vfs_expand_initial_tilde</a> (const char *path);
83
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-unescape-string-for-display">gnome_vfs_unescape_string_for_display</a>
77
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-expand-initial-tilde" title="gnome_vfs_expand_initial_tilde ()">gnome_vfs_expand_initial_tilde</a> (const char *path);
78
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-unescape-string-for-display" title="gnome_vfs_unescape_string_for_display ()">gnome_vfs_unescape_string_for_display</a>
84
79
(const char *escaped);
85
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-get-local-path-from-uri">gnome_vfs_get_local_path_from_uri</a> (const char *uri);
86
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-get-uri-from-local-path">gnome_vfs_get_uri_from_local_path</a> (const char *local_full_path);
87
gboolean <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-is-executable-command-string">gnome_vfs_is_executable_command_string</a>
80
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-get-local-path-from-uri" title="gnome_vfs_get_local_path_from_uri ()">gnome_vfs_get_local_path_from_uri</a> (const char *uri);
81
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-get-uri-from-local-path" title="gnome_vfs_get_uri_from_local_path ()">gnome_vfs_get_uri_from_local_path</a> (const char *local_full_path);
82
<a
83
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
84
>gboolean</a> <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-is-executable-command-string" title="gnome_vfs_is_executable_command_string ()">gnome_vfs_is_executable_command_string</a>
88
85
(const char *command_string);
89
void <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-list-deep-free">gnome_vfs_list_deep_free</a> (GList *list);
90
<a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-get-volume-free-space">gnome_vfs_get_volume_free_space</a> (const <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI">GnomeVFSURI</a> *vfs_uri,
91
<a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> *size);
92
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-icon-path-from-filename">gnome_vfs_icon_path_from_filename</a> (const char *filename);
93
gboolean <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-is-primary-thread">gnome_vfs_is_primary_thread</a> (void);
94
char* <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-get-uri-scheme">gnome_vfs_get_uri_scheme</a> (const char *uri);
95
gboolean <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-uris-match">gnome_vfs_uris_match</a> (const char *uri_1,
86
void <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-list-deep-free" title="gnome_vfs_list_deep_free ()">gnome_vfs_list_deep_free</a> (<a
87
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
88
>GList</a> *list);
89
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-get-volume-free-space" title="gnome_vfs_get_volume_free_space ()">gnome_vfs_get_volume_free_space</a> (const <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *vfs_uri,
90
<a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> *size);
91
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-icon-path-from-filename" title="gnome_vfs_icon_path_from_filename ()">gnome_vfs_icon_path_from_filename</a> (const char *filename);
92
<a
93
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
94
>gboolean</a> <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-is-primary-thread" title="gnome_vfs_is_primary_thread ()">gnome_vfs_is_primary_thread</a> (void);
95
char* <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-get-uri-scheme" title="gnome_vfs_get_uri_scheme ()">gnome_vfs_get_uri_scheme</a> (const char *uri);
96
<a
97
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
98
>gboolean</a> <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-uris-match" title="gnome_vfs_uris_match ()">gnome_vfs_uris_match</a> (const char *uri_1,
96
99
const char *uri_2);
97
#define <a href="gnome-vfs-20-gnome-vfs-utils.html#GNOME-VFS-ASSERT-PRIMARY-THREAD:CAPS">GNOME_VFS_ASSERT_PRIMARY_THREAD</a>
98
#define <a href="gnome-vfs-20-gnome-vfs-utils.html#GNOME-VFS-ASSERT-SECONDARY-THREAD:CAPS">GNOME_VFS_ASSERT_SECONDARY_THREAD</a>
99
<a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-open-fd">gnome_vfs_open_fd</a> (GnomeVFSHandle **handle,
100
#define <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#GNOME-VFS-ASSERT-PRIMARY-THREAD:CAPS" title="GNOME_VFS_ASSERT_PRIMARY_THREAD">GNOME_VFS_ASSERT_PRIMARY_THREAD</a>
101
#define <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#GNOME-VFS-ASSERT-SECONDARY-THREAD:CAPS" title="GNOME_VFS_ASSERT_SECONDARY_THREAD">GNOME_VFS_ASSERT_SECONDARY_THREAD</a>
102
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-open-fd" title="gnome_vfs_open_fd ()">gnome_vfs_open_fd</a> (GnomeVFSHandle **handle,
100
103
int filedes);
101
<a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-read-entire-file">gnome_vfs_read_entire_file</a> (const char *uri,
104
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-read-entire-file" title="gnome_vfs_read_entire_file ()">gnome_vfs_read_entire_file</a> (const char *uri,
102
105
int *file_size,
103
106
char **file_contents);
104
107
</pre>
105
108
</div>
106
109
<div class="refsect1" lang="en">
107
<a name="id2575197"></a><h2>Description</h2>
110
<a name="gnome-vfs-20-gnome-vfs-utils.description"></a><h2>Description</h2>
108
111
<p>
109
112
110
113
</p>
111
114
</div>
112
115
<div class="refsect1" lang="en">
113
<a name="id2575212"></a><h2>Details</h2>
116
<a name="gnome-vfs-20-gnome-vfs-utils.details"></a><h2>Details</h2>
114
117
<div class="refsect2" lang="en">
115
<a name="id2575222"></a><h3>
116
<a name="GnomeVFSMakeURIDirs"></a>enum GnomeVFSMakeURIDirs</h3>
117
<a class="indexterm" name="id2575235"></a><pre class="programlisting">typedef enum {
118
<a name="GnomeVFSMakeURIDirs"></a><h3>enum GnomeVFSMakeURIDirs</h3>
119
<pre class="programlisting">typedef enum {
118
120
GNOME_VFS_MAKE_URI_DIR_NONE = 0,
119
121
GNOME_VFS_MAKE_URI_DIR_HOMEDIR = 1 << 0,
120
122
GNOME_VFS_MAKE_URI_DIR_CURRENT = 1 << 1
121
123
} GnomeVFSMakeURIDirs;
122
124
</pre>
123
125
<p>
124
Flags that can be passed to <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input-with-dirs"><code class="function">gnome_vfs_make_uri_from_input_with_dirs()</code></a>.
126
Flags that can be passed to <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input-with-dirs" title="gnome_vfs_make_uri_from_input_with_dirs ()"><code class="function">gnome_vfs_make_uri_from_input_with_dirs()</code></a>.
125
127
If the given input might be a relative path it checks for existence of the file
126
128
in the directory specified by this flag.
127
129
If both flags are passed the current directory is checked first.</p>
132
134
<col align="left" valign="top">
133
135
<tbody>
134
136
<tr>
135
<td><span class="term"><a name="GNOME-VFS-MAKE-URI-DIR-NONE:CAPS"></a><code class="literal">GNOME_VFS_MAKE_URI_DIR_NONE</code></span></td>
137
<td><p><a name="GNOME-VFS-MAKE-URI-DIR-NONE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MAKE_URI_DIR_NONE</code></span></p></td>
136
138
<td> Don't check any directory
137
139
</td>
138
140
</tr>
139
141
<tr>
140
<td><span class="term"><a name="GNOME-VFS-MAKE-URI-DIR-HOMEDIR:CAPS"></a><code class="literal">GNOME_VFS_MAKE_URI_DIR_HOMEDIR</code></span></td>
142
<td><p><a name="GNOME-VFS-MAKE-URI-DIR-HOMEDIR:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MAKE_URI_DIR_HOMEDIR</code></span></p></td>
141
143
<td> Check the home directory
142
144
</td>
143
145
</tr>
144
146
<tr>
145
<td><span class="term"><a name="GNOME-VFS-MAKE-URI-DIR-CURRENT:CAPS"></a><code class="literal">GNOME_VFS_MAKE_URI_DIR_CURRENT</code></span></td>
147
<td><p><a name="GNOME-VFS-MAKE-URI-DIR-CURRENT:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MAKE_URI_DIR_CURRENT</code></span></p></td>
146
148
<td> Check the current direcotry
147
149
</td>
148
150
</tr>
151
153
</div>
152
154
<hr>
153
155
<div class="refsect2" lang="en">
154
<a name="id2575344"></a><h3>
155
<a name="gnome-vfs-format-file-size-for-display"></a>gnome_vfs_format_file_size_for_display ()</h3>
156
<a class="indexterm" name="id2575357"></a><pre class="programlisting">char* gnome_vfs_format_file_size_for_display
157
(<a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> size);</pre>
156
<a name="gnome-vfs-format-file-size-for-display"></a><h3>gnome_vfs_format_file_size_for_display ()</h3>
157
<pre class="programlisting">char* gnome_vfs_format_file_size_for_display
158
(<a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> size);</pre>
158
159
<p>
159
160
Formats the file <em class="parameter"><code>size</code></em> passed so that it is easy for
160
161
the user to read. Gives the size in bytes, kilobytes, megabytes or
166
167
<col align="left" valign="top">
167
168
<tbody>
168
169
<tr>
169
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
170
<td> a <a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> (a <span class="type">guint64</span> value).
170
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
171
<td> a <a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> (a <a
172
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
173
><span class="type">guint64</span></a> value).
171
174
</td>
172
175
</tr>
173
176
<tr>
174
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
177
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
175
178
<td> a newly allocated string with the size ready to be shown.
176
179
</td>
177
180
</tr>
180
183
</div>
181
184
<hr>
182
185
<div class="refsect2" lang="en">
183
<a name="id2575446"></a><h3>
184
<a name="gnome-vfs-format-uri-for-display"></a>gnome_vfs_format_uri_for_display ()</h3>
185
<a class="indexterm" name="id2575461"></a><pre class="programlisting">char* gnome_vfs_format_uri_for_display (const char *uri);</pre>
186
<a name="gnome-vfs-format-uri-for-display"></a><h3>gnome_vfs_format_uri_for_display ()</h3>
187
<pre class="programlisting">char* gnome_vfs_format_uri_for_display (const char *uri);</pre>
186
188
<p>
187
189
Filter, modify, unescape and change <em class="parameter"><code>uri</code></em> to make it appropriate
188
190
for display to users. The conversion is done such that the roundtrip
200
202
<col align="left" valign="top">
201
203
<tbody>
202
204
<tr>
203
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
205
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
204
206
<td> uri to be displayed.
205
207
</td>
206
208
</tr>
207
209
<tr>
208
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
210
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
209
211
<td> a newly allocated string which represents <em class="parameter"><code>uri</code></em> and can be displayed.
210
212
211
213
</td>
217
219
</div>
218
220
<hr>
219
221
<div class="refsect2" lang="en">
220
<a name="id2575549"></a><h3>
221
<a name="gnome-vfs-url-show"></a>gnome_vfs_url_show ()</h3>
222
<a class="indexterm" name="id2575564"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_url_show (const char *url);</pre>
222
<a name="gnome-vfs-url-show"></a><h3>gnome_vfs_url_show ()</h3>
223
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_url_show (const char *url);</pre>
223
224
<p>
224
225
Launches the default application or component associated with the given <em class="parameter"><code>url</code></em>.</p>
225
226
<p>
229
230
<col align="left" valign="top">
230
231
<tbody>
231
232
<tr>
232
<td><span class="term"><em class="parameter"><code>url</code></em> :</span></td>
233
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
233
234
<td> url to be shown.
234
235
</td>
235
236
</tr>
236
237
<tr>
237
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
238
<td> <a href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> if the default action was launched,
239
<a href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-BAD-PARAMETERS:CAPS"><code class="literal">GNOME_VFS_ERROR_BAD_PARAMETERS</code></a> for an invalid or non-existant <em class="parameter"><code>url</code></em>,
240
<a href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-NO-DEFAULT:CAPS"><code class="literal">GNOME_VFS_ERROR_NO_DEFAULT</code></a> if no default action is associated with the <em class="parameter"><code>url</code></em>.
241
Also error codes from <a href="gnome-vfs-20-gnome-vfs-mime-database-deprecated.html#gnome-vfs-mime-action-launch"><code class="function">gnome_vfs_mime_action_launch()</code></a>
242
or <a href="gnome-vfs-20-gnome-vfs-mime-database-deprecated.html#gnome-vfs-mime-action-launch-with-env"><code class="function">gnome_vfs_mime_action_launch_with_env()</code></a>.
238
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
239
<td> <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> if the default action was launched,
240
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-BAD-PARAMETERS:CAPS"><code class="literal">GNOME_VFS_ERROR_BAD_PARAMETERS</code></a> for an invalid or non-existant <em class="parameter"><code>url</code></em>,
241
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-NO-DEFAULT:CAPS"><code class="literal">GNOME_VFS_ERROR_NO_DEFAULT</code></a> if no default action is associated with the <em class="parameter"><code>url</code></em>.
242
Also error codes from <a class="link" href="gnome-vfs-20-gnome-vfs-mime-database-deprecated.html#gnome-vfs-mime-action-launch" title="gnome_vfs_mime_action_launch ()"><code class="function">gnome_vfs_mime_action_launch()</code></a>
243
or <a class="link" href="gnome-vfs-20-gnome-vfs-mime-database-deprecated.html#gnome-vfs-mime-action-launch-with-env" title="gnome_vfs_mime_action_launch_with_env ()"><code class="function">gnome_vfs_mime_action_launch_with_env()</code></a>.
243
244
244
245
</td>
245
246
</tr>
250
251
</div>
251
252
<hr>
252
253
<div class="refsect2" lang="en">
253
<a name="id2575710"></a><h3>
254
<a name="gnome-vfs-url-show-with-env"></a>gnome_vfs_url_show_with_env ()</h3>
255
<a class="indexterm" name="id2575726"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_url_show_with_env (const char *url,
254
<a name="gnome-vfs-url-show-with-env"></a><h3>gnome_vfs_url_show_with_env ()</h3>
255
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_url_show_with_env (const char *url,
256
256
char **envp);</pre>
257
257
<p>
258
Like <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-url-show"><code class="function">gnome_vfs_url_show()</code></a> except that the default action will be launched
258
Like <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-url-show" title="gnome_vfs_url_show ()"><code class="function">gnome_vfs_url_show()</code></a> except that the default action will be launched
259
259
with the given environment.</p>
260
260
<p>
261
261
264
264
<col align="left" valign="top">
265
265
<tbody>
266
266
<tr>
267
<td><span class="term"><em class="parameter"><code>url</code></em> :</span></td>
267
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
268
268
<td> url to be shown.
269
269
</td>
270
270
</tr>
271
271
<tr>
272
<td><span class="term"><em class="parameter"><code>envp</code></em> :</span></td>
272
<td><p><span class="term"><em class="parameter"><code>envp</code></em> :</span></p></td>
273
273
<td> environment data.
274
274
</td>
275
275
</tr>
276
276
<tr>
277
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
278
<td> <a href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> if the default action was launched.
279
<a href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-BAD-PARAMETERS:CAPS"><code class="literal">GNOME_VFS_ERROR_BAD_PARAMETERS</code></a> for an invalid or non-existant <em class="parameter"><code>url</code></em>,
280
<a href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-NO-DEFAULT:CAPS"><code class="literal">GNOME_VFS_ERROR_NO_DEFAULT</code></a> if no default action is associated with the <em class="parameter"><code>url</code></em>.
281
Also error codes from <a href="gnome-vfs-20-gnome-vfs-mime-database.html#gnome-vfs-mime-application-launch-with-env"><code class="function">gnome_vfs_mime_application_launch_with_env()</code></a>
282
or <a href="gnome-vfs-20-gnome-vfs-mime-database-deprecated.html#gnome-vfs-mime-action-launch-with-env"><code class="function">gnome_vfs_mime_action_launch_with_env()</code></a>.
277
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
278
<td> <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> if the default action was launched.
279
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-BAD-PARAMETERS:CAPS"><code class="literal">GNOME_VFS_ERROR_BAD_PARAMETERS</code></a> for an invalid or non-existant <em class="parameter"><code>url</code></em>,
280
<a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-NO-DEFAULT:CAPS"><code class="literal">GNOME_VFS_ERROR_NO_DEFAULT</code></a> if no default action is associated with the <em class="parameter"><code>url</code></em>.
281
Also error codes from <a class="link" href="gnome-vfs-20-gnome-vfs-mime-database.html#gnome-vfs-mime-application-launch-with-env" title="gnome_vfs_mime_application_launch_with_env ()"><code class="function">gnome_vfs_mime_application_launch_with_env()</code></a>
282
or <a class="link" href="gnome-vfs-20-gnome-vfs-mime-database-deprecated.html#gnome-vfs-mime-action-launch-with-env" title="gnome_vfs_mime_action_launch_with_env ()"><code class="function">gnome_vfs_mime_action_launch_with_env()</code></a>.
283
283
284
284
</td>
285
285
</tr>
290
290
</div>
291
291
<hr>
292
292
<div class="refsect2" lang="en">
293
<a name="id2575898"></a><h3>
294
<a name="gnome-vfs-escape-string"></a>gnome_vfs_escape_string ()</h3>
295
<a class="indexterm" name="id2575911"></a><pre class="programlisting">char* gnome_vfs_escape_string (const char *string);</pre>
293
<a name="gnome-vfs-escape-string"></a><h3>gnome_vfs_escape_string ()</h3>
294
<pre class="programlisting">char* gnome_vfs_escape_string (const char *string);</pre>
296
295
<p>
297
296
Escapes <em class="parameter"><code>string</code></em>, replacing any and all special characters
298
297
with equivalent escape sequences.</p>
303
302
<col align="left" valign="top">
304
303
<tbody>
305
304
<tr>
306
<td><span class="term"><em class="parameter"><code>string</code></em> :</span></td>
305
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
307
306
<td> string to be escaped.
308
307
</td>
309
308
</tr>
310
309
<tr>
311
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
310
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
312
311
<td> a newly allocated string equivalent to <em class="parameter"><code>string</code></em>
313
312
but with all special characters escaped.
314
313
</td>
318
317
</div>
319
318
<hr>
320
319
<div class="refsect2" lang="en">
321
<a name="id2575986"></a><h3>
322
<a name="gnome-vfs-escape-path-string"></a>gnome_vfs_escape_path_string ()</h3>
323
<a class="indexterm" name="id2575999"></a><pre class="programlisting">char* gnome_vfs_escape_path_string (const char *path);</pre>
320
<a name="gnome-vfs-escape-path-string"></a><h3>gnome_vfs_escape_path_string ()</h3>
321
<pre class="programlisting">char* gnome_vfs_escape_path_string (const char *path);</pre>
324
322
<p>
325
323
Escapes <em class="parameter"><code>path</code></em>, replacing only special characters that would not
326
324
be found in paths (so '/', '&', and '=' will not be escaped by
332
330
<col align="left" valign="top">
333
331
<tbody>
334
332
<tr>
335
<td><span class="term"><em class="parameter"><code>path</code></em> :</span></td>
333
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
336
334
<td> string to be escaped.
337
335
</td>
338
336
</tr>
339
337
<tr>
340
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
338
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
341
339
<td> a newly allocated string equivalent to <em class="parameter"><code>path</code></em> but
342
340
with non-path characters escaped.
343
341
</td>
347
345
</div>
348
346
<hr>
349
347
<div class="refsect2" lang="en">
350
<a name="id2576075"></a><h3>
351
<a name="gnome-vfs-escape-host-and-path-string"></a>gnome_vfs_escape_host_and_path_string ()</h3>
352
<a class="indexterm" name="id2576089"></a><pre class="programlisting">char* gnome_vfs_escape_host_and_path_string
348
<a name="gnome-vfs-escape-host-and-path-string"></a><h3>gnome_vfs_escape_host_and_path_string ()</h3>
349
<pre class="programlisting">char* gnome_vfs_escape_host_and_path_string
353
350
(const char *path);</pre>
354
351
<p>
355
352
Escapes <em class="parameter"><code>path</code></em>, replacing only special characters that would not
362
359
<col align="left" valign="top">
363
360
<tbody>
364
361
<tr>
365
<td><span class="term"><em class="parameter"><code>path</code></em> :</span></td>
362
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
366
363
<td> string to be escaped.
367
364
</td>
368
365
</tr>
369
366
<tr>
370
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
367
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
371
368
<td> a newly allocated string equivalent to <em class="parameter"><code>path</code></em> but
372
369
with non-path/host characters escaped.
373
370
</td>
377
374
</div>
378
375
<hr>
379
376
<div class="refsect2" lang="en">
380
<a name="id2576167"></a><h3>
381
<a name="gnome-vfs-escape-slashes"></a>gnome_vfs_escape_slashes ()</h3>
382
<a class="indexterm" name="id2576180"></a><pre class="programlisting">char* gnome_vfs_escape_slashes (const char *string);</pre>
377
<a name="gnome-vfs-escape-slashes"></a><h3>gnome_vfs_escape_slashes ()</h3>
378
<pre class="programlisting">char* gnome_vfs_escape_slashes (const char *string);</pre>
383
379
<p>
384
380
Escapes only '/' and '%' characters in <em class="parameter"><code>string</code></em>, replacing
385
381
them with their escape sequence equivalents.</p>
390
386
<col align="left" valign="top">
391
387
<tbody>
392
388
<tr>
393
<td><span class="term"><em class="parameter"><code>string</code></em> :</span></td>
389
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
394
390
<td> string to be escaped.
395
391
</td>
396
392
</tr>
397
393
<tr>
398
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
394
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
399
395
<td> a newly allocated string equivalent to <em class="parameter"><code>string</code></em>,
400
396
but with no unescaped '/' or '%' characters.
401
397
</td>
405
401
</div>
406
402
<hr>
407
403
<div class="refsect2" lang="en">
408
<a name="id2576255"></a><h3>
409
<a name="gnome-vfs-escape-set"></a>gnome_vfs_escape_set ()</h3>
410
<a class="indexterm" name="id2576268"></a><pre class="programlisting">char* gnome_vfs_escape_set (const char *string,
404
<a name="gnome-vfs-escape-set"></a><h3>gnome_vfs_escape_set ()</h3>
405
<pre class="programlisting">char* gnome_vfs_escape_set (const char *string,
411
406
const char *match_set);</pre>
412
407
<p>
413
408
Escapes all characters in <em class="parameter"><code>string</code></em> which are listed in <em class="parameter"><code>match_set</code></em>.</p>
418
413
<col align="left" valign="top">
419
414
<tbody>
420
415
<tr>
421
<td><span class="term"><em class="parameter"><code>string</code></em> :</span></td>
416
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
422
417
<td> string to be escaped.
423
418
</td>
424
419
</tr>
425
420
<tr>
426
<td><span class="term"><em class="parameter"><code>match_set</code></em> :</span></td>
421
<td><p><span class="term"><em class="parameter"><code>match_set</code></em> :</span></p></td>
427
422
<td> a string containing all characters to be escaped in <em class="parameter"><code>string</code></em>.
428
423
</td>
429
424
</tr>
430
425
<tr>
431
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
426
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
432
427
<td> a newly allocated string equivalent to <em class="parameter"><code>string</code></em> but
433
428
with characters in <em class="parameter"><code>match_string</code></em> escaped.
434
429
</td>
438
433
</div>
439
434
<hr>
440
435
<div class="refsect2" lang="en">
441
<a name="id2576382"></a><h3>
442
<a name="gnome-vfs-unescape-string"></a>gnome_vfs_unescape_string ()</h3>
443
<a class="indexterm" name="id2576395"></a><pre class="programlisting">char* gnome_vfs_unescape_string (const char *escaped_string,
436
<a name="gnome-vfs-unescape-string"></a><h3>gnome_vfs_unescape_string ()</h3>
437
<pre class="programlisting">char* gnome_vfs_unescape_string (const char *escaped_string,
444
438
const char *illegal_characters);</pre>
445
439
<p>
446
440
Decodes escaped characters (i.e. PERCENTxx sequences) in <em class="parameter"><code>escaped_string</code></em>.
453
447
<col align="left" valign="top">
454
448
<tbody>
455
449
<tr>
456
<td><span class="term"><em class="parameter"><code>escaped_string</code></em> :</span></td>
450
<td><p><span class="term"><em class="parameter"><code>escaped_string</code></em> :</span></p></td>
457
451
<td> an escaped uri, path, or other string.
458
452
</td>
459
453
</tr>
460
454
<tr>
461
<td><span class="term"><em class="parameter"><code>illegal_characters</code></em> :</span></td>
455
<td><p><span class="term"><em class="parameter"><code>illegal_characters</code></em> :</span></p></td>
462
456
<td> a string containing a sequence of characters
463
457
considered "illegal" to be escaped, '\0' is automatically in this list.
464
458
</td>
465
459
</tr>
466
460
<tr>
467
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
461
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
468
462
<td> a newly allocated string with the unescaped
469
equivalents, or <code class="literal">NULL</code> if <em class="parameter"><code>escaped_string</code></em> contained an escaped
463
equivalents, or <a
464
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
465
><code class="literal">NULL</code></a> if <em class="parameter"><code>escaped_string</code></em> contained an escaped
470
466
encoding of one of the characters in <em class="parameter"><code>illegal_characters</code></em>.
471
467
</td>
472
468
</tr>
475
471
</div>
476
472
<hr>
477
473
<div class="refsect2" lang="en">
478
<a name="id2576512"></a><h3>
479
<a name="gnome-vfs-make-uri-canonical"></a>gnome_vfs_make_uri_canonical ()</h3>
480
<a class="indexterm" name="id2576528"></a><pre class="programlisting">char* gnome_vfs_make_uri_canonical (const char *uri);</pre>
474
<a name="gnome-vfs-make-uri-canonical"></a><h3>gnome_vfs_make_uri_canonical ()</h3>
475
<pre class="programlisting">char* gnome_vfs_make_uri_canonical (const char *uri);</pre>
481
476
<p>
482
477
Standardizes the format of the <em class="parameter"><code>uri</code></em>, so that it can be used
483
478
later in other functions that expect a canonical uri.</p>
488
483
<col align="left" valign="top">
489
484
<tbody>
490
485
<tr>
491
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
486
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
492
487
<td> an absolute or relative stringified uri. It might have scheme.
493
488
</td>
494
489
</tr>
495
490
<tr>
496
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
491
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
497
492
<td> a newly allocated string that contains the canonical
498
493
representation of <em class="parameter"><code>uri</code></em>.
499
494
506
501
</div>
507
502
<hr>
508
503
<div class="refsect2" lang="en">
509
<a name="id2576610"></a><h3>
510
<a name="gnome-vfs-make-uri-canonical-strip-fragment"></a>gnome_vfs_make_uri_canonical_strip_fragment ()</h3>
511
<a class="indexterm" name="id2576626"></a><pre class="programlisting">char* gnome_vfs_make_uri_canonical_strip_fragment
504
<a name="gnome-vfs-make-uri-canonical-strip-fragment"></a><h3>gnome_vfs_make_uri_canonical_strip_fragment ()</h3>
505
<pre class="programlisting">char* gnome_vfs_make_uri_canonical_strip_fragment
512
506
(const char *uri);</pre>
513
507
<p>
514
508
Returns a canonicalized uri. If <em class="parameter"><code>uri</code></em> contains a fragment (anything after a '#') strips off that and
520
514
<col align="left" valign="top">
521
515
<tbody>
522
516
<tr>
523
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
524
<td> a <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>.
517
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
518
<td> a <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>.
525
519
</td>
526
520
</tr>
527
521
<tr>
528
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
522
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
529
523
<td> a newly allocated string containing a canonical <em class="parameter"><code>uri</code></em>.
530
524
531
525
</td>
537
531
</div>
538
532
<hr>
539
533
<div class="refsect2" lang="en">
540
<a name="id2576720"></a><h3>
541
<a name="gnome-vfs-make-path-name-canonical"></a>gnome_vfs_make_path_name_canonical ()</h3>
542
<a class="indexterm" name="id2576735"></a><pre class="programlisting">char* gnome_vfs_make_path_name_canonical (const char *path);</pre>
534
<a name="gnome-vfs-make-path-name-canonical"></a><h3>gnome_vfs_make_path_name_canonical ()</h3>
535
<pre class="programlisting">char* gnome_vfs_make_path_name_canonical (const char *path);</pre>
543
536
<p>
544
537
Calls <code class="function">_gnome_vfs_canonicalize_pathname()</code>, allocating storage for the
545
538
result and providing for a cleaner memory management.</p>
550
543
<col align="left" valign="top">
551
544
<tbody>
552
545
<tr>
553
<td><span class="term"><em class="parameter"><code>path</code></em> :</span></td>
546
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
554
547
<td> a file path, relative or absolute.
555
548
</td>
556
549
</tr>
557
550
<tr>
558
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
551
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
559
552
<td> a canonical version of <em class="parameter"><code>path</code></em>.
560
553
</td>
561
554
</tr>
564
557
</div>
565
558
<hr>
566
559
<div class="refsect2" lang="en">
567
<a name="id2576815"></a><h3>
568
<a name="gnome-vfs-make-uri-from-input"></a>gnome_vfs_make_uri_from_input ()</h3>
569
<a class="indexterm" name="id2576831"></a><pre class="programlisting">char* gnome_vfs_make_uri_from_input (const char *location);</pre>
560
<a name="gnome-vfs-make-uri-from-input"></a><h3>gnome_vfs_make_uri_from_input ()</h3>
561
<pre class="programlisting">char* gnome_vfs_make_uri_from_input (const char *location);</pre>
570
562
<p>
571
563
Takes a user input path/uri and makes a valid uri out of it.
572
564
</p>
573
565
<p>
574
This function is the reverse of <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-format-uri-for-display"><code class="function">gnome_vfs_format_uri_for_display()</code></a>
566
This function is the reverse of <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-format-uri-for-display" title="gnome_vfs_format_uri_for_display ()"><code class="function">gnome_vfs_format_uri_for_display()</code></a>
575
567
but it also handles the fact that the user could have typed
576
568
arbitrary UTF-8 in the entry showing the string.</p>
577
569
<p>
581
573
<col align="left" valign="top">
582
574
<tbody>
583
575
<tr>
584
<td><span class="term"><em class="parameter"><code>location</code></em> :</span></td>
576
<td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
585
577
<td> a possibly mangled "uri", in UTF-8.
586
578
</td>
587
579
</tr>
588
580
<tr>
589
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
581
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
590
582
<td> a newly allocated uri.
591
583
592
584
</td>
598
590
</div>
599
591
<hr>
600
592
<div class="refsect2" lang="en">
601
<a name="id2576917"></a><h3>
602
<a name="gnome-vfs-make-uri-from-input-with-dirs"></a>gnome_vfs_make_uri_from_input_with_dirs ()</h3>
603
<a class="indexterm" name="id2576934"></a><pre class="programlisting">char* gnome_vfs_make_uri_from_input_with_dirs
593
<a name="gnome-vfs-make-uri-from-input-with-dirs"></a><h3>gnome_vfs_make_uri_from_input_with_dirs ()</h3>
594
<pre class="programlisting">char* gnome_vfs_make_uri_from_input_with_dirs
604
595
(const char *location,
605
<a href="gnome-vfs-20-gnome-vfs-utils.html#GnomeVFSMakeURIDirs">GnomeVFSMakeURIDirs</a> dirs);</pre>
596
<a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#GnomeVFSMakeURIDirs" title="enum GnomeVFSMakeURIDirs">GnomeVFSMakeURIDirs</a> dirs);</pre>
606
597
<p>
607
598
Determines a fully qualified uri from a relative or absolute input path.
608
Basically calls <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input"><code class="function">gnome_vfs_make_uri_from_input()</code></a> except it specifically
599
Basically calls <a class="link" href="gnome-vfs-20-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> except it specifically
609
600
tries to support paths relative to the specified directories (can be homedir
610
and/or current directory). See <a href="gnome-vfs-20-gnome-vfs-utils.html#GnomeVFSMakeURIDirs"><span class="type">GnomeVFSMakeURIDirs</span></a> for more information.</p>
601
and/or current directory). See <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#GnomeVFSMakeURIDirs" title="enum GnomeVFSMakeURIDirs"><span class="type">GnomeVFSMakeURIDirs</span></a> for more information.</p>
611
602
<p>
612
603
613
604
</p>
615
606
<col align="left" valign="top">
616
607
<tbody>
617
608
<tr>
618
<td><span class="term"><em class="parameter"><code>location</code></em> :</span></td>
609
<td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
619
610
<td> a relative or absolute path.
620
611
</td>
621
612
</tr>
622
613
<tr>
623
<td><span class="term"><em class="parameter"><code>dirs</code></em> :</span></td>
614
<td><p><span class="term"><em class="parameter"><code>dirs</code></em> :</span></p></td>
624
615
<td> directory to use as a base directory if <em class="parameter"><code>location</code></em> is a relative path.
625
616
</td>
626
617
</tr>
627
618
<tr>
628
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
619
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
629
620
<td> a newly allocated string containing the fully qualified uri.
630
621
631
622
</td>
637
628
</div>
638
629
<hr>
639
630
<div class="refsect2" lang="en">
640
<a name="id2577056"></a><h3>
641
<a name="gnome-vfs-make-uri-from-shell-arg"></a>gnome_vfs_make_uri_from_shell_arg ()</h3>
642
<a class="indexterm" name="id2577073"></a><pre class="programlisting">char* gnome_vfs_make_uri_from_shell_arg (const char *uri);</pre>
631
<a name="gnome-vfs-make-uri-from-shell-arg"></a><h3>gnome_vfs_make_uri_from_shell_arg ()</h3>
632
<pre class="programlisting">char* gnome_vfs_make_uri_from_shell_arg (const char *uri);</pre>
643
633
<p>
644
Similar to <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-make-uri-from-input"><code class="function">gnome_vfs_make_uri_from_input()</code></a>, except that:
634
Similar to <a class="link" href="gnome-vfs-20-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>, except that:
645
635
</p>
646
636
<p>
647
637
1) guesses relative paths instead of http domains.
654
644
<col align="left" valign="top">
655
645
<tbody>
656
646
<tr>
657
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
647
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
658
648
<td> path to make the uri from.
659
649
</td>
660
650
</tr>
661
651
<tr>
662
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
652
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
663
653
<td> a newly allocated string representing <em class="parameter"><code>uri</code></em>.
664
654
665
655
</td>
671
661
</div>
672
662
<hr>
673
663
<div class="refsect2" lang="en">
674
<a name="id2577163"></a><h3>
675
<a name="gnome-vfs-make-uri-full-from-relative"></a>gnome_vfs_make_uri_full_from_relative ()</h3>
676
<a class="indexterm" name="id2577179"></a><a class="indexterm" name="id2577188"></a><pre class="programlisting">char* gnome_vfs_make_uri_full_from_relative
664
<a name="gnome-vfs-make-uri-full-from-relative"></a><h3>gnome_vfs_make_uri_full_from_relative ()</h3>
665
<pre class="programlisting">char* gnome_vfs_make_uri_full_from_relative
677
666
(const char *base_uri,
678
667
const char *relative_uri);</pre>
679
668
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
680
669
<h3 class="title">Warning</h3>
681
670
<p><code class="literal">gnome_vfs_make_uri_full_from_relative</code> is deprecated and should not be used in newly-written code. This function is deprecated, please use
682
<a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-make-full-from-relative"><code class="function">gnome_vfs_uri_make_full_from_relative()</code></a> from gnome-vfs-uri.h .</p>
671
<a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-make-full-from-relative" title="gnome_vfs_uri_make_full_from_relative ()"><code class="function">gnome_vfs_uri_make_full_from_relative()</code></a> from gnome-vfs-uri.h .</p>
683
672
</div>
684
673
<p>
685
674
Returns a string representing the full uri given a full <em class="parameter"><code>base_uri</code></em> and a
691
680
<col align="left" valign="top">
692
681
<tbody>
693
682
<tr>
694
<td><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></td>
683
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td>
695
684
<td> path to use as the base for the full uri.
696
685
</td>
697
686
</tr>
698
687
<tr>
699
<td><span class="term"><em class="parameter"><code>relative_uri</code></em> :</span></td>
688
<td><p><span class="term"><em class="parameter"><code>relative_uri</code></em> :</span></p></td>
700
689
<td> full or relative path to be appended to the <em class="parameter"><code>base_uri</code></em>.
701
690
</td>
702
691
</tr>
703
692
<tr>
704
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
693
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
705
694
<td> a newly allocated string containing the uri.
706
(<code class="literal">NULL</code> for some bad errors).
695
(<a
696
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
697
><code class="literal">NULL</code></a> for some bad errors).
707
698
708
699
</td>
709
700
</tr>
714
705
</div>
715
706
<hr>
716
707
<div class="refsect2" lang="en">
717
<a name="id2577327"></a><h3>
718
<a name="gnome-vfs-expand-initial-tilde"></a>gnome_vfs_expand_initial_tilde ()</h3>
719
<a class="indexterm" name="id2577340"></a><pre class="programlisting">char* gnome_vfs_expand_initial_tilde (const char *path);</pre>
708
<a name="gnome-vfs-expand-initial-tilde"></a><h3>gnome_vfs_expand_initial_tilde ()</h3>
709
<pre class="programlisting">char* gnome_vfs_expand_initial_tilde (const char *path);</pre>
720
710
<p>
721
711
If <em class="parameter"><code>path</code></em> starts with a ~, representing the user's home
722
712
directory, expand it to the actual path location.</p>
727
717
<col align="left" valign="top">
728
718
<tbody>
729
719
<tr>
730
<td><span class="term"><em class="parameter"><code>path</code></em> :</span></td>
720
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
731
721
<td> a local file path which may start with a '~'.
732
722
</td>
733
723
</tr>
734
724
<tr>
735
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
725
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
736
726
<td> a newly allocated string with the initial
737
727
tilde (if there was one) converted to an actual path.
738
728
</td>
742
732
</div>
743
733
<hr>
744
734
<div class="refsect2" lang="en">
745
<a name="id2577411"></a><h3>
746
<a name="gnome-vfs-unescape-string-for-display"></a>gnome_vfs_unescape_string_for_display ()</h3>
747
<a class="indexterm" name="id2577424"></a><pre class="programlisting">char* gnome_vfs_unescape_string_for_display
735
<a name="gnome-vfs-unescape-string-for-display"></a><h3>gnome_vfs_unescape_string_for_display ()</h3>
736
<pre class="programlisting">char* gnome_vfs_unescape_string_for_display
748
737
(const char *escaped);</pre>
749
738
<p>
750
739
Similar to gnome_vfs_unescape_string, but it returns something
752
741
such as <code class="literal">00</code> or URIs in bad form.
753
742
</p>
754
743
<p>
755
See also: <a href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-unescape-string"><code class="function">gnome_vfs_unescape_string()</code></a>.
744
See also: <a class="link" href="gnome-vfs-20-gnome-vfs-utils.html#gnome-vfs-unescape-string" title="gnome_vfs_unescape_string ()"><code class="function">gnome_vfs_unescape_string()</code></a>.
756
745
</p>
757
746
<p>
758
747
WARNING: You should never use this function on a whole URI! It
766
755
<col align="left" valign="top">
767
756
<tbody>
768
757
<tr>
769
<td><span class="term"><em class="parameter"><code>escaped</code></em> :</span></td>
758
<td><p><span class="term"><em class="parameter"><code>escaped</code></em> :</span></p></td>
770
759
<td> a string encoded with escaped sequences.
771
760
</td>
772
761
</tr>
773
762
<tr>
774
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
763
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
775
764
<td> a pointer to a g_malloc'd string with all characters
776
765
replacing their escaped hex values.
777
766
</td>
781
770
</div>
782
771
<hr>
783
772
<div class="refsect2" lang="en">
784
<a name="id2577525"></a><h3>
785
<a name="gnome-vfs-get-local-path-from-uri"></a>gnome_vfs_get_local_path_from_uri ()</h3>
786
<a class="indexterm" name="id2577540"></a><pre class="programlisting">char* gnome_vfs_get_local_path_from_uri (const char *uri);</pre>
773
<a name="gnome-vfs-get-local-path-from-uri"></a><h3>gnome_vfs_get_local_path_from_uri ()</h3>
774
<pre class="programlisting">char* gnome_vfs_get_local_path_from_uri (const char *uri);</pre>
787
775
<p>
788
776
Create a local path for a file:/// uri. Do not use with uris
789
777
of other methods.</p>
794
782
<col align="left" valign="top">
795
783
<tbody>
796
784
<tr>
797
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
785
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
798
786
<td> uri to convert to a local path.
799
787
</td>
800
788
</tr>
801
789
<tr>
802
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
790
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
803
791
<td> a newly allocated string containing the local path.
804
<code class="literal">NULL</code> is returned on error or if the uri isn't a file: uri
792
<a
793
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
794
><code class="literal">NULL</code></a> is returned on error or if the uri isn't a file: uri
805
795
without a fragment identifier (or chained uri).
806
796
</td>
807
797
</tr>
810
800
</div>
811
801
<hr>
812
802
<div class="refsect2" lang="en">
813
<a name="id2577614"></a><h3>
814
<a name="gnome-vfs-get-uri-from-local-path"></a>gnome_vfs_get_uri_from_local_path ()</h3>
815
<a class="indexterm" name="id2577628"></a><pre class="programlisting">char* gnome_vfs_get_uri_from_local_path (const char *local_full_path);</pre>
803
<a name="gnome-vfs-get-uri-from-local-path"></a><h3>gnome_vfs_get_uri_from_local_path ()</h3>
804
<pre class="programlisting">char* gnome_vfs_get_uri_from_local_path (const char *local_full_path);</pre>
816
805
<p>
817
806
Returns a file:/// URI for the local path <em class="parameter"><code>local_full_path</code></em>,
818
such as a path provided by <code class="function">gtk_file_chooser_get_filename()</code>.
819
The resulting URI may be provided, for instance, to <a href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-new"><code class="function">gnome_vfs_uri_new()</code></a>.
807
such as a path provided by <a
808
href="/usr/share/gtk-doc/html/gtk/GtkFileChooser.html#gtk-file-chooser-get-filename"
809
><code class="function">gtk_file_chooser_get_filename()</code></a>.
810
The resulting URI may be provided, for instance, to <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#gnome-vfs-uri-new" title="gnome_vfs_uri_new ()"><code class="function">gnome_vfs_uri_new()</code></a>.
820
811
</p>
821
812
<p>
822
813
On Windows <em class="parameter"><code>local_full_path</code></em> should be in the UTF-8 encoding, and can start with a drive
828
819
<col align="left" valign="top">
829
820
<tbody>
830
821
<tr>
831
<td><span class="term"><em class="parameter"><code>local_full_path</code></em> :</span></td>
822
<td><p><span class="term"><em class="parameter"><code>local_full_path</code></em> :</span></p></td>
832
823
<td> a full local filesystem path (i.e. not relative).
833
824
</td>
834
825
</tr>
835
826
<tr>
836
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
827
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
837
828
<td> a newly allocated string containing the uri corresponding
838
to <em class="parameter"><code>local_full_path</code></em> (<code class="literal">NULL</code> for some bad errors).
829
to <em class="parameter"><code>local_full_path</code></em> (<a
830
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
831
><code class="literal">NULL</code></a> for some bad errors).
839
832
</td>
840
833
</tr>
841
834
</tbody>
843
836
</div>
844
837
<hr>
845
838
<div class="refsect2" lang="en">
846
<a name="id2577748"></a><h3>
847
<a name="gnome-vfs-is-executable-command-string"></a>gnome_vfs_is_executable_command_string ()</h3>
848
<a class="indexterm" name="id2577762"></a><pre class="programlisting">gboolean gnome_vfs_is_executable_command_string
839
<a name="gnome-vfs-is-executable-command-string"></a><h3>gnome_vfs_is_executable_command_string ()</h3>
840
<pre class="programlisting"><a
841
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
842
>gboolean</a> gnome_vfs_is_executable_command_string
849
843
(const char *command_string);</pre>
850
844
<p>
851
845
Checks if <em class="parameter"><code>command_string</code></em> starts with the full path of an executable file
857
851
<col align="left" valign="top">
858
852
<tbody>
859
853
<tr>
860
<td><span class="term"><em class="parameter"><code>command_string</code></em> :</span></td>
854
<td><p><span class="term"><em class="parameter"><code>command_string</code></em> :</span></p></td>
861
855
<td> a string representing a command ie "xterm -bg white".
862
856
</td>
863
857
</tr>
864
858
<tr>
865
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
866
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>command_string</code></em> started with an executable file, and is in $PATH,
867
<code class="literal">FALSE</code> otherwise.
859
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
860
<td> <a
861
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
862
><code class="literal">TRUE</code></a> if <em class="parameter"><code>command_string</code></em> started with an executable file, and is in $PATH,
863
<a
864
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
865
><code class="literal">FALSE</code></a> otherwise.
868
866
</td>
869
867
</tr>
870
868
</tbody>
872
870
</div>
873
871
<hr>
874
872
<div class="refsect2" lang="en">
875
<a name="id2577859"></a><h3>
876
<a name="gnome-vfs-list-deep-free"></a>gnome_vfs_list_deep_free ()</h3>
877
<a class="indexterm" name="id2577871"></a><pre class="programlisting">void gnome_vfs_list_deep_free (GList *list);</pre>
873
<a name="gnome-vfs-list-deep-free"></a><h3>gnome_vfs_list_deep_free ()</h3>
874
<pre class="programlisting">void gnome_vfs_list_deep_free (<a
875
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
876
>GList</a> *list);</pre>
878
877
<p>
879
Free <em class="parameter"><code>list</code></em> and call <code class="function">g_free()</code> on all data members.</p>
878
Free <em class="parameter"><code>list</code></em> and call <a
879
href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"
880
><code class="function">g_free()</code></a> on all data members.</p>
880
881
<p>
881
882
882
883
</p>
883
884
<div class="variablelist"><table border="0">
884
885
<col align="left" valign="top">
885
886
<tbody><tr>
886
<td><span class="term"><em class="parameter"><code>list</code></em> :</span></td>
887
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
887
888
<td> list to be freed.
888
889
</td>
889
890
</tr></tbody>
891
892
</div>
892
893
<hr>
893
894
<div class="refsect2" lang="en">
894
<a name="id2577940"></a><h3>
895
<a name="gnome-vfs-get-volume-free-space"></a>gnome_vfs_get_volume_free_space ()</h3>
896
<a class="indexterm" name="id2577953"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_get_volume_free_space (const <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI">GnomeVFSURI</a> *vfs_uri,
897
<a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize">GnomeVFSFileSize</a> *size);</pre>
895
<a name="gnome-vfs-get-volume-free-space"></a><h3>gnome_vfs_get_volume_free_space ()</h3>
896
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_get_volume_free_space (const <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *vfs_uri,
897
<a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> *size);</pre>
898
898
<p>
899
899
Stores the amount of free space in bytes on <em class="parameter"><code>vfs</code></em>-uri's
900
900
volume in <em class="parameter"><code>size</code></em>.</p>
905
905
<col align="left" valign="top">
906
906
<tbody>
907
907
<tr>
908
<td><span class="term"><em class="parameter"><code>vfs_uri</code></em> :</span></td>
909
<td> a <a href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>.
910
</td>
911
</tr>
912
<tr>
913
<td><span class="term"><em class="parameter"><code>size</code></em> :</span></td>
914
<td> a <a href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a>.
915
</td>
916
</tr>
917
<tr>
918
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
919
<td> <a href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> on success, otherwise an
908
<td><p><span class="term"><em class="parameter"><code>vfs_uri</code></em> :</span></p></td>
909
<td> a <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>.
910
</td>
911
</tr>
912
<tr>
913
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
914
<td> a <a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a>.
915
</td>
916
</tr>
917
<tr>
918
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
919
<td> <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> on success, otherwise an
920
920
<code class="literal">GNOME_VFS_ERROR_</code>* code.
921
921
</td>
922
922
</tr>
925
925
</div>
926
926
<hr>
927
927
<div class="refsect2" lang="en">
928
<a name="id2578087"></a><h3>
929
<a name="gnome-vfs-icon-path-from-filename"></a>gnome_vfs_icon_path_from_filename ()</h3>
930
<a class="indexterm" name="id2578100"></a><pre class="programlisting">char* gnome_vfs_icon_path_from_filename (const char *filename);</pre>
928
<a name="gnome-vfs-icon-path-from-filename"></a><h3>gnome_vfs_icon_path_from_filename ()</h3>
929
<pre class="programlisting">char* gnome_vfs_icon_path_from_filename (const char *filename);</pre>
931
930
<p>
932
931
</p>
933
932
<p>
937
936
<col align="left" valign="top">
938
937
<tbody>
939
938
<tr>
940
<td><span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
939
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
941
940
<td> path to a file. Could be relative or absolute path.
942
941
</td>
943
942
</tr>
944
943
<tr>
945
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
944
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
946
945
<td> Returns the icon path for the <em class="parameter"><code>filename</code></em>. Example:
947
946
gnome_vfs_icon_path_from_filename ("nautilus/nautilus-desktop.png") will return a string
948
947
forming the full path of the file nautilus-desktop.png ie $PREFIX/share/pixmaps/nautilus/nautilus-desktop.png.
953
952
</div>
954
953
<hr>
955
954
<div class="refsect2" lang="en">
956
<a name="id2578171"></a><h3>
957
<a name="gnome-vfs-is-primary-thread"></a>gnome_vfs_is_primary_thread ()</h3>
958
<a class="indexterm" name="id2578184"></a><pre class="programlisting">gboolean gnome_vfs_is_primary_thread (void);</pre>
955
<a name="gnome-vfs-is-primary-thread"></a><h3>gnome_vfs_is_primary_thread ()</h3>
956
<pre class="programlisting"><a
957
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
958
>gboolean</a> gnome_vfs_is_primary_thread (void);</pre>
959
959
<p>
960
960
Check if the current thread is the thread with the main glib event loop.</p>
961
961
<p>
964
964
<div class="variablelist"><table border="0">
965
965
<col align="left" valign="top">
966
966
<tbody><tr>
967
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
968
<td> <code class="literal">TRUE</code> if the current thread is the thread with the
967
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
968
<td> <a
969
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
970
><code class="literal">TRUE</code></a> if the current thread is the thread with the
969
971
main glib event loop.
970
972
</td>
971
973
</tr></tbody>
973
975
</div>
974
976
<hr>
975
977
<div class="refsect2" lang="en">
976
<a name="id2578236"></a><h3>
977
<a name="gnome-vfs-get-uri-scheme"></a>gnome_vfs_get_uri_scheme ()</h3>
978
<a class="indexterm" name="id2578251"></a><pre class="programlisting">char* gnome_vfs_get_uri_scheme (const char *uri);</pre>
978
<a name="gnome-vfs-get-uri-scheme"></a><h3>gnome_vfs_get_uri_scheme ()</h3>
979
<pre class="programlisting">char* gnome_vfs_get_uri_scheme (const char *uri);</pre>
979
980
<p>
980
981
Retrieve the scheme used in <em class="parameter"><code>uri</code></em>.</p>
981
982
<p>
985
986
<col align="left" valign="top">
986
987
<tbody>
987
988
<tr>
988
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
989
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
989
990
<td> a stringified uri.
990
991
</td>
991
992
</tr>
992
993
<tr>
993
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
994
<td> a newly allocated string containing the scheme, <code class="literal">NULL</code>
994
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
995
<td> a newly allocated string containing the scheme, <a
996
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
997
><code class="literal">NULL</code></a>
995
998
if <em class="parameter"><code>uri</code></em> doesn't contain a scheme.
996
999
997
1000
</td>
1003
1006
</div>
1004
1007
<hr>
1005
1008
<div class="refsect2" lang="en">
1006
<a name="id2578341"></a><h3>
1007
<a name="gnome-vfs-uris-match"></a>gnome_vfs_uris_match ()</h3>
1008
<a class="indexterm" name="id2578357"></a><pre class="programlisting">gboolean gnome_vfs_uris_match (const char *uri_1,
1009
<a name="gnome-vfs-uris-match"></a><h3>gnome_vfs_uris_match ()</h3>
1010
<pre class="programlisting"><a
1011
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
1012
>gboolean</a> gnome_vfs_uris_match (const char *uri_1,
1009
1013
const char *uri_2);</pre>
1010
1014
<p>
1011
1015
Compare two uris.</p>
1016
1020
<col align="left" valign="top">
1017
1021
<tbody>
1018
1022
<tr>
1019
<td><span class="term"><em class="parameter"><code>uri_1</code></em> :</span></td>
1023
<td><p><span class="term"><em class="parameter"><code>uri_1</code></em> :</span></p></td>
1020
1024
<td> stringified uri to compare with <em class="parameter"><code>uri_2</code></em>.
1021
1025
</td>
1022
1026
</tr>
1023
1027
<tr>
1024
<td><span class="term"><em class="parameter"><code>uri_2</code></em> :</span></td>
1028
<td><p><span class="term"><em class="parameter"><code>uri_2</code></em> :</span></p></td>
1025
1029
<td> stringified uri to compare with <em class="parameter"><code>uri_1</code></em>.
1026
1030
</td>
1027
1031
</tr>
1028
1032
<tr>
1029
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1030
<td> <code class="literal">TRUE</code> if they are the same, <code class="literal">FALSE</code> otherwise.
1033
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1034
<td> <a
1035
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
1036
><code class="literal">TRUE</code></a> if they are the same, <a
1037
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
1038
><code class="literal">FALSE</code></a> otherwise.
1031
1039
1032
1040
</td>
1033
1041
</tr>
1038
1046
</div>
1039
1047
<hr>
1040
1048
<div class="refsect2" lang="en">
1041
<a name="id2578479"></a><h3>
1042
<a name="GNOME-VFS-ASSERT-PRIMARY-THREAD:CAPS"></a>GNOME_VFS_ASSERT_PRIMARY_THREAD</h3>
1043
<a class="indexterm" name="id2578493"></a><pre class="programlisting">#define GNOME_VFS_ASSERT_PRIMARY_THREAD g_assert (gnome_vfs_is_primary_thread())
1049
<a name="GNOME-VFS-ASSERT-PRIMARY-THREAD:CAPS"></a><h3>GNOME_VFS_ASSERT_PRIMARY_THREAD</h3>
1050
<pre class="programlisting">#define GNOME_VFS_ASSERT_PRIMARY_THREAD g_assert (gnome_vfs_is_primary_thread())
1044
1051
</pre>
1045
1052
<p>
1046
1053
Asserts that the current thread is the thread with
1051
1058
</div>
1052
1059
<hr>
1053
1060
<div class="refsect2" lang="en">
1054
<a name="id2578514"></a><h3>
1055
<a name="GNOME-VFS-ASSERT-SECONDARY-THREAD:CAPS"></a>GNOME_VFS_ASSERT_SECONDARY_THREAD</h3>
1056
<a class="indexterm" name="id2578528"></a><pre class="programlisting">#define GNOME_VFS_ASSERT_SECONDARY_THREAD g_assert (!gnome_vfs_is_primary_thread())
1061
<a name="GNOME-VFS-ASSERT-SECONDARY-THREAD:CAPS"></a><h3>GNOME_VFS_ASSERT_SECONDARY_THREAD</h3>
1062
<pre class="programlisting">#define GNOME_VFS_ASSERT_SECONDARY_THREAD g_assert (!gnome_vfs_is_primary_thread())
1057
1063
</pre>
1058
1064
<p>
1059
1065
Asserts that the current thread is NOT the thread with
1064
1070
</div>
1065
1071
<hr>
1066
1072
<div class="refsect2" lang="en">
1067
<a name="id2578549"></a><h3>
1068
<a name="gnome-vfs-open-fd"></a>gnome_vfs_open_fd ()</h3>
1069
<a class="indexterm" name="id2578563"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_open_fd (GnomeVFSHandle **handle,
1073
<a name="gnome-vfs-open-fd"></a><h3>gnome_vfs_open_fd ()</h3>
1074
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_open_fd (GnomeVFSHandle **handle,
1070
1075
int filedes);</pre>
1071
1076
<p>
1072
1077
Converts an open unix file descript into a GnomeVFSHandle that
1079
1084
<col align="left" valign="top">
1080
1085
<tbody>
1081
1086
<tr>
1082
<td><span class="term"><em class="parameter"><code>handle</code></em> :</span></td>
1087
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
1083
1088
<td> A pointer to a pointer to a GnomeVFSHandle object
1084
1089
</td>
1085
1090
</tr>
1086
1091
<tr>
1087
<td><span class="term"><em class="parameter"><code>filedes</code></em> :</span></td>
1092
<td><p><span class="term"><em class="parameter"><code>filedes</code></em> :</span></p></td>
1088
1093
<td> a UNIX file descriptor
1089
1094
</td>
1090
1095
</tr>
1091
1096
<tr>
1092
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1093
<td> <a href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> if the open was ok, a suitable error otherwise.
1097
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1098
<td> <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> if the open was ok, a suitable error otherwise.
1094
1099
1095
1100
Since 2.2
1096
1101
</td>
1100
1105
</div>
1101
1106
<hr>
1102
1107
<div class="refsect2" lang="en">
1103
<a name="id2578659"></a><h3>
1104
<a name="gnome-vfs-read-entire-file"></a>gnome_vfs_read_entire_file ()</h3>
1105
<a class="indexterm" name="id2578674"></a><pre class="programlisting"><a href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_read_entire_file (const char *uri,
1108
<a name="gnome-vfs-read-entire-file"></a><h3>gnome_vfs_read_entire_file ()</h3>
1109
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> gnome_vfs_read_entire_file (const char *uri,
1106
1110
int *file_size,
1107
1111
char **file_contents);</pre>
1108
1112
<p>
1119
1123
<col align="left" valign="top">
1120
1124
<tbody>
1121
1125
<tr>
1122
<td><span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
1126
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
1123
1127
<td> uri of the file to read.
1124
1128
</td>
1125
1129
</tr>
1126
1130
<tr>
1127
<td><span class="term"><em class="parameter"><code>file_size</code></em> :</span></td>
1131
<td><p><span class="term"><em class="parameter"><code>file_size</code></em> :</span></p></td>
1128
1132
<td> after reading the file, contains the size of the file read.
1129
1133
</td>
1130
1134
</tr>
1131
1135
<tr>
1132
<td><span class="term"><em class="parameter"><code>file_contents</code></em> :</span></td>
1136
<td><p><span class="term"><em class="parameter"><code>file_contents</code></em> :</span></p></td>
1133
1137
<td> contains the file_size bytes, the contents of the file at <em class="parameter"><code>uri</code></em>.
1134
1138
</td>
1135
1139
</tr>
1136
1140
<tr>
1137
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1141
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1138
1142
<td> an integer representing the result of the operation.
1139
1143
1140
1144
</td>
1146
1150
</div>
1147
1151
</div>
1148
1152
</div>
1153
<div class="footer">
1154
<hr>
1155
Generated by GTK-Doc V1.10</div>
1149
1156
</body>
1150
1157
</html>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1