← Back to branch summary

~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

Viewing changes to docs/reference/gio/xml/gvfs.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/xml/gvfs.xml
5
5
]>
6
6
<refentry id="GVfs">
7
7
<refmeta>
8
 
<refentrytitle role="top_of_page">GVfs</refentrytitle>
 
8
<refentrytitle role="top_of_page" id="GVfs.top_of_page">GVfs</refentrytitle>
9
9
<manvolnum>3</manvolnum>
10
10
<refmiscinfo>GIO Library</refmiscinfo>
11
11
</refmeta>
13
13
<refnamediv>
14
14
<refname>GVfs</refname>
15
15
<refpurpose>Virtual File System</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
 
<refsynopsisdiv role="synopsis">
 
18
<refsynopsisdiv id="GVfs.synopsis" role="synopsis">
20
19
<title role="synopsis.title">Synopsis</title>
21
20
 
22
21
<synopsis>
23
22
 
24
23
#include &lt;gio/gio.h&gt;
25
24
 
26
 
 
27
25
                    <link linkend="GVfs-struct">GVfs</link>;
28
 
#define             <link linkend="G-VFS-EXTENSION-POINT-NAME:CAPS">G_VFS_EXTENSION_POINT_NAME</link>
29
 
<link linkend="GFile">GFile</link>*              <link linkend="g-vfs-get-file-for-path">g_vfs_get_file_for_path</link>             (<link linkend="GVfs">GVfs</link> *vfs,
 
26
#define             <link linkend="G-VFS-EXTENSION-POINT-NAME--CAPS">G_VFS_EXTENSION_POINT_NAME</link>
 
27
<link linkend="GFile">GFile</link> *             <link linkend="g-vfs-get-file-for-path">g_vfs_get_file_for_path</link>             (<link linkend="GVfs">GVfs</link> *vfs,
30
28
                                                         const <link linkend="char">char</link> *path);
31
 
<link linkend="GFile">GFile</link>*              <link linkend="g-vfs-get-file-for-uri">g_vfs_get_file_for_uri</link>              (<link linkend="GVfs">GVfs</link> *vfs,
 
29
<link linkend="GFile">GFile</link> *             <link linkend="g-vfs-get-file-for-uri">g_vfs_get_file_for_uri</link>              (<link linkend="GVfs">GVfs</link> *vfs,
32
30
                                                         const <link linkend="char">char</link> *uri);
33
 
<link linkend="GFile">GFile</link>*              <link linkend="g-vfs-parse-name">g_vfs_parse_name</link>                    (<link linkend="GVfs">GVfs</link> *vfs,
 
31
<link linkend="GFile">GFile</link> *             <link linkend="g-vfs-parse-name">g_vfs_parse_name</link>                    (<link linkend="GVfs">GVfs</link> *vfs,
34
32
                                                         const <link linkend="char">char</link> *parse_name);
35
 
<link linkend="GVfs">GVfs</link>*               <link linkend="g-vfs-get-default">g_vfs_get_default</link>                   (void);
36
 
<link linkend="GVfs">GVfs</link>*               <link linkend="g-vfs-get-local">g_vfs_get_local</link>                     (void);
 
33
<link linkend="GVfs">GVfs</link> *              <link linkend="g-vfs-get-default">g_vfs_get_default</link>                   (void);
 
34
<link linkend="GVfs">GVfs</link> *              <link linkend="g-vfs-get-local">g_vfs_get_local</link>                     (void);
37
35
<link linkend="gboolean">gboolean</link>            <link linkend="g-vfs-is-active">g_vfs_is_active</link>                     (<link linkend="GVfs">GVfs</link> *vfs);
38
 
 
39
 
 
 
36
const <link linkend="gchar">gchar</link>* const * <link linkend="g-vfs-get-supported-uri-schemes">g_vfs_get_supported_uri_schemes</link>    (<link linkend="GVfs">GVfs</link> *vfs);
40
37
</synopsis>
41
38
</refsynopsisdiv>
42
39
 
43
 
<refsect1 role="object_hierarchy">
 
40
<refsect1 id="GVfs.object-hierarchy" role="object_hierarchy">
44
41
<title role="object_hierarchy.title">Object Hierarchy</title>
45
42
<synopsis>
46
 
 
47
43
  <link linkend="GObject">GObject</link>
48
44
   +----GVfs
49
45
</synopsis>
50
 
 
51
46
</refsect1>
52
47
 
53
48
 
57
52
 
58
53
 
59
54
 
60
 
<refsect1 role="desc">
 
55
<refsect1 id="GVfs.description" role="desc">
61
56
<title role="desc.title">Description</title>
62
57
<para>
63
58
Entry point for using GIO functionality.</para>
64
59
<para>
65
 
 
66
60
</para>
67
61
</refsect1>
68
62
 
69
 
<refsect1 role="details">
 
63
<refsect1 id="GVfs.details" role="details">
70
64
<title role="details.title">Details</title>
71
 
<refsect2>
72
 
<title><anchor id="GVfs-struct" role="struct"/>GVfs</title>
73
 
<indexterm><primary>GVfs</primary></indexterm><programlisting>typedef struct _GVfs GVfs;</programlisting>
 
65
<refsect2 id="GVfs-struct" role="struct">
 
66
<title>GVfs</title>
 
67
<indexterm zone="GVfs-struct"><primary sortas="GVfs">GVfs</primary></indexterm><programlisting>typedef struct _GVfs GVfs;</programlisting>
74
68
<para>
75
69
Virtual File System object.</para>
76
70
<para>
77
 
 
78
71
</para></refsect2>
79
 
<refsect2>
80
 
<title><anchor id="G-VFS-EXTENSION-POINT-NAME:CAPS" role="macro"/>G_VFS_EXTENSION_POINT_NAME</title>
81
 
<indexterm><primary>G_VFS_EXTENSION_POINT_NAME</primary></indexterm><programlisting>#define G_VFS_EXTENSION_POINT_NAME "gio-vfs"
 
72
<refsect2 id="G-VFS-EXTENSION-POINT-NAME--CAPS" role="macro">
 
73
<title>G_VFS_EXTENSION_POINT_NAME</title>
 
74
<indexterm zone="G-VFS-EXTENSION-POINT-NAME--CAPS"><primary sortas="G_VFS_EXTENSION_POINT_NAME">G_VFS_EXTENSION_POINT_NAME</primary></indexterm><programlisting>#define G_VFS_EXTENSION_POINT_NAME "gio-vfs"
82
75
</programlisting>
83
76
<para>
84
 
Extension point for <link linkend="GVfs"><type>GVfs</type></link> functionality. 
85
 
See <link linkend="gio-extension-points">Extending GIO</link>.</para>
 
77
Extension point for <link linkend="GVfs"><type>GVfs</type></link> functionality.
 
78
See <link linkend="extending-gio">Extending GIO</link>.</para>
86
79
<para>
87
 
 
88
80
</para></refsect2>
89
 
<refsect2>
90
 
<title><anchor id="g-vfs-get-file-for-path" role="function"/>g_vfs_get_file_for_path ()</title>
91
 
<indexterm><primary>g_vfs_get_file_for_path</primary></indexterm><programlisting><link linkend="GFile">GFile</link>*              g_vfs_get_file_for_path             (<link linkend="GVfs">GVfs</link> *vfs,
 
81
<refsect2 id="g-vfs-get-file-for-path" role="function">
 
82
<title>g_vfs_get_file_for_path ()</title>
 
83
<indexterm zone="g-vfs-get-file-for-path"><primary sortas="g_vfs_get_file_for_path">g_vfs_get_file_for_path</primary></indexterm><programlisting><link linkend="GFile">GFile</link> *             g_vfs_get_file_for_path             (<link linkend="GVfs">GVfs</link> *vfs,
92
84
                                                         const <link linkend="char">char</link> *path);</programlisting>
93
85
<para>
94
86
Gets a <link linkend="GFile"><type>GFile</type></link> for <parameter>path</parameter>.</para>
95
87
<para>
96
 
 
97
88
</para><variablelist role="params">
98
 
<varlistentry><term><parameter>vfs</parameter>&nbsp;:</term>
 
89
<varlistentry><term><parameter>vfs</parameter>&#160;:</term>
99
90
<listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>.
100
91
</simpara></listitem></varlistentry>
101
 
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
92
<varlistentry><term><parameter>path</parameter>&#160;:</term>
102
93
<listitem><simpara> a string containing a VFS path.
103
94
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GFile"><type>GFile</type></link>.
 
95
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GFile"><type>GFile</type></link>. 
 
96
    Free the returned object with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.
105
97
</simpara></listitem></varlistentry>
106
98
</variablelist></refsect2>
107
 
<refsect2>
108
 
<title><anchor id="g-vfs-get-file-for-uri" role="function"/>g_vfs_get_file_for_uri ()</title>
109
 
<indexterm><primary>g_vfs_get_file_for_uri</primary></indexterm><programlisting><link linkend="GFile">GFile</link>*              g_vfs_get_file_for_uri              (<link linkend="GVfs">GVfs</link> *vfs,
 
99
<refsect2 id="g-vfs-get-file-for-uri" role="function">
 
100
<title>g_vfs_get_file_for_uri ()</title>
 
101
<indexterm zone="g-vfs-get-file-for-uri"><primary sortas="g_vfs_get_file_for_uri">g_vfs_get_file_for_uri</primary></indexterm><programlisting><link linkend="GFile">GFile</link> *             g_vfs_get_file_for_uri              (<link linkend="GVfs">GVfs</link> *vfs,
110
102
                                                         const <link linkend="char">char</link> *uri);</programlisting>
111
103
<para>
112
104
Gets a <link linkend="GFile"><type>GFile</type></link> for <parameter>uri</parameter>.
113
105
</para>
114
106
<para>
115
107
This operation never fails, but the returned object
116
 
might not support any I/O operation if the uri
117
 
is malformed or if the uri type is not supported.</para>
 
108
might not support any I/O operation if the URI 
 
109
is malformed or if the URI scheme is not supported.</para>
118
110
<para>
119
 
 
120
111
</para><variablelist role="params">
121
 
<varlistentry><term><parameter>vfs</parameter>&nbsp;:</term>
 
112
<varlistentry><term><parameter>vfs</parameter>&#160;:</term>
122
113
<listitem><simpara> a<link linkend="GVfs"><type>GVfs</type></link>.
123
114
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
125
 
<listitem><simpara> a string containing a URI path.
 
115
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
 
116
<listitem><simpara> a string containing a URI 
126
117
</simpara></listitem></varlistentry>
127
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GFile"><type>GFile</type></link>. 
128
 
 
 
118
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GFile"><type>GFile</type></link>. 
 
119
    Free the returned object with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.
129
120
</simpara></listitem></varlistentry>
130
121
</variablelist></refsect2>
131
 
<refsect2>
132
 
<title><anchor id="g-vfs-parse-name" role="function"/>g_vfs_parse_name ()</title>
133
 
<indexterm><primary>g_vfs_parse_name</primary></indexterm><programlisting><link linkend="GFile">GFile</link>*              g_vfs_parse_name                    (<link linkend="GVfs">GVfs</link> *vfs,
 
122
<refsect2 id="g-vfs-parse-name" role="function">
 
123
<title>g_vfs_parse_name ()</title>
 
124
<indexterm zone="g-vfs-parse-name"><primary sortas="g_vfs_parse_name">g_vfs_parse_name</primary></indexterm><programlisting><link linkend="GFile">GFile</link> *             g_vfs_parse_name                    (<link linkend="GVfs">GVfs</link> *vfs,
134
125
                                                         const <link linkend="char">char</link> *parse_name);</programlisting>
135
126
<para>
136
127
This operation never fails, but the returned object might 
137
128
not support any I/O operations if the <parameter>parse_name</parameter> cannot 
138
129
be parsed by the <link linkend="GVfs"><type>GVfs</type></link> module.</para>
139
130
<para>
140
 
 
141
131
</para><variablelist role="params">
142
 
<varlistentry><term><parameter>vfs</parameter>&nbsp;:</term>
 
132
<varlistentry><term><parameter>vfs</parameter>&#160;:</term>
143
133
<listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>.
144
134
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><parameter>parse_name</parameter>&nbsp;:</term>
 
135
<varlistentry><term><parameter>parse_name</parameter>&#160;:</term>
146
136
<listitem><simpara> a string to be parsed by the VFS module.
147
137
</simpara></listitem></varlistentry>
148
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GFile"><type>GFile</type></link> for the given <parameter>parse_name</parameter>.
 
138
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GFile"><type>GFile</type></link> for the given <parameter>parse_name</parameter>.
 
139
    Free the returned object with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.
149
140
</simpara></listitem></varlistentry>
150
141
</variablelist></refsect2>
151
 
<refsect2>
152
 
<title><anchor id="g-vfs-get-default" role="function"/>g_vfs_get_default ()</title>
153
 
<indexterm><primary>g_vfs_get_default</primary></indexterm><programlisting><link linkend="GVfs">GVfs</link>*               g_vfs_get_default                   (void);</programlisting>
 
142
<refsect2 id="g-vfs-get-default" role="function">
 
143
<title>g_vfs_get_default ()</title>
 
144
<indexterm zone="g-vfs-get-default"><primary sortas="g_vfs_get_default">g_vfs_get_default</primary></indexterm><programlisting><link linkend="GVfs">GVfs</link> *              g_vfs_get_default                   (void);</programlisting>
154
145
<para>
155
146
Gets the default <link linkend="GVfs"><type>GVfs</type></link> for the system.</para>
156
147
<para>
157
 
 
158
148
</para><variablelist role="params">
159
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>. 
 
149
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>. 
160
150
</simpara></listitem></varlistentry>
161
151
</variablelist></refsect2>
162
 
<refsect2>
163
 
<title><anchor id="g-vfs-get-local" role="function"/>g_vfs_get_local ()</title>
164
 
<indexterm><primary>g_vfs_get_local</primary></indexterm><programlisting><link linkend="GVfs">GVfs</link>*               g_vfs_get_local                     (void);</programlisting>
 
152
<refsect2 id="g-vfs-get-local" role="function">
 
153
<title>g_vfs_get_local ()</title>
 
154
<indexterm zone="g-vfs-get-local"><primary sortas="g_vfs_get_local">g_vfs_get_local</primary></indexterm><programlisting><link linkend="GVfs">GVfs</link> *              g_vfs_get_local                     (void);</programlisting>
165
155
<para>
166
156
Gets the local <link linkend="GVfs"><type>GVfs</type></link> for the system.</para>
167
157
<para>
168
 
 
169
158
</para><variablelist role="params">
170
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>.
 
159
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>.
171
160
</simpara></listitem></varlistentry>
172
161
</variablelist></refsect2>
173
 
<refsect2>
174
 
<title><anchor id="g-vfs-is-active" role="function"/>g_vfs_is_active ()</title>
175
 
<indexterm><primary>g_vfs_is_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_vfs_is_active                     (<link linkend="GVfs">GVfs</link> *vfs);</programlisting>
 
162
<refsect2 id="g-vfs-is-active" role="function">
 
163
<title>g_vfs_is_active ()</title>
 
164
<indexterm zone="g-vfs-is-active"><primary sortas="g_vfs_is_active">g_vfs_is_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_vfs_is_active                     (<link linkend="GVfs">GVfs</link> *vfs);</programlisting>
176
165
<para>
177
166
Checks if the VFS is active.</para>
178
167
<para>
179
 
 
180
 
</para><variablelist role="params">
181
 
<varlistentry><term><parameter>vfs</parameter>&nbsp;:</term>
182
 
<listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>.
183
 
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if construction of the <parameter>vfs</parameter> was successful and it is now active.
 
168
</para><variablelist role="params">
 
169
<varlistentry><term><parameter>vfs</parameter>&#160;:</term>
 
170
<listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>.
 
171
</simpara></listitem></varlistentry>
 
172
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if construction of the <parameter>vfs</parameter> was successful and it is now active.
 
173
</simpara></listitem></varlistentry>
 
174
</variablelist></refsect2>
 
175
<refsect2 id="g-vfs-get-supported-uri-schemes" role="function">
 
176
<title>g_vfs_get_supported_uri_schemes ()</title>
 
177
<indexterm zone="g-vfs-get-supported-uri-schemes"><primary sortas="g_vfs_get_supported_uri_schemes">g_vfs_get_supported_uri_schemes</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* const * g_vfs_get_supported_uri_schemes    (<link linkend="GVfs">GVfs</link> *vfs);</programlisting>
 
178
<para>
 
179
Gets a list of URI schemes supported by <parameter>vfs</parameter>.</para>
 
180
<para>
 
181
</para><variablelist role="params">
 
182
<varlistentry><term><parameter>vfs</parameter>&#160;:</term>
 
183
<listitem><simpara> a <link linkend="GVfs"><type>GVfs</type></link>.
 
184
</simpara></listitem></varlistentry>
 
185
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated array of strings.
 
186
    The returned array belongs to GIO and must 
 
187
    not be freed or modified.
185
188
</simpara></listitem></varlistentry>
186
189
</variablelist></refsect2>
187
190
 
190
193
 
191
194
 
192
195
 
193
 
 
194
 
<refsect1><refsect2 /><refsect2 /></refsect1>
195
196
</refentry>