← Back to branch summary

~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-09 11:28:22 UTC
  • mfrom: (3.4.8 experimental)
  • Revision ID: james.westby@ubuntu.com-20100309112822-j4n0v3xbtsup8s97
Tags: 2.23.5-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler
* debian/rules:
  - don't break build on test suite errors, debian recently activated this but
    the build breaks even when there is no error in the testsuite

Show diffs side-by-side

added added

removed removed

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