← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/xml/gnome-vfs-file-basic-ops.xml

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/gnome-vfs-file-basic-ops.xml
1
1
<refentry id="gnome-vfs-20-gnome-vfs-file-basic-ops">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page">Basic File Operations</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="gnome-vfs-20-gnome-vfs-file-basic-ops.top_of_page">Basic File Operations</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
6
6
</refmeta>
11
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
12
</refnamediv>
13
13
 
14
 
<refsynopsisdiv role="synopsis">
 
14
<refsynopsisdiv id="gnome-vfs-20-gnome-vfs-file-basic-ops.synopsis" role="synopsis">
15
15
<title role="synopsis.title">Synopsis</title>
16
16
 
17
17
<synopsis>
18
 
 
19
 
 
20
 
 
21
18
enum                <link linkend="GnomeVFSOpenMode">GnomeVFSOpenMode</link>;
22
19
<link linkend="GnomeVFSResult">GnomeVFSResult</link>      <link linkend="gnome-vfs-create">gnome_vfs_create</link>                    (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
23
20
                                                         const <link linkend="gchar">gchar</link> *text_uri,
64
61
 
65
62
 
66
63
 
67
 
<refsect1 role="desc">
 
64
<refsect1 id="gnome-vfs-20-gnome-vfs-file-basic-ops.description" role="desc">
68
65
<title role="desc.title">Description</title>
69
66
<para>
70
67
GnomeVFS file operations are, for the most part, patterned after
76
73
</para>
77
74
</refsect1>
78
75
 
79
 
<refsect1 role="details">
 
76
<refsect1 id="gnome-vfs-20-gnome-vfs-file-basic-ops.details" role="details">
80
77
<title role="details.title">Details</title>
81
 
<refsect2>
82
 
<title><anchor id="GnomeVFSOpenMode" role="enum"/>enum GnomeVFSOpenMode</title>
83
 
<indexterm><primary>GnomeVFSOpenMode</primary></indexterm><programlisting>typedef enum {
 
78
<refsect2 id="GnomeVFSOpenMode" role="enum">
 
79
<title>enum GnomeVFSOpenMode</title>
 
80
<indexterm zone="GnomeVFSOpenMode"><primary>GnomeVFSOpenMode</primary></indexterm><programlisting>typedef enum {
84
81
        GNOME_VFS_OPEN_NONE = 0,
85
82
        GNOME_VFS_OPEN_READ = 1 &lt;&lt; 0,
86
83
        GNOME_VFS_OPEN_WRITE = 1 &lt;&lt; 1,
94
91
<para>
95
92
 
96
93
</para><variablelist role="enum">
97
 
<varlistentry>
98
 
<term><anchor id="GNOME-VFS-OPEN-NONE:CAPS" role="constant"/><literal>GNOME_VFS_OPEN_NONE</literal></term>
 
94
<varlistentry id="GNOME-VFS-OPEN-NONE:CAPS" role="constant">
 
95
<term><literal>GNOME_VFS_OPEN_NONE</literal></term>
99
96
<listitem><simpara> No access.
100
97
</simpara></listitem>
101
98
</varlistentry>
102
 
<varlistentry>
103
 
<term><anchor id="GNOME-VFS-OPEN-READ:CAPS" role="constant"/><literal>GNOME_VFS_OPEN_READ</literal></term>
 
99
<varlistentry id="GNOME-VFS-OPEN-READ:CAPS" role="constant">
 
100
<term><literal>GNOME_VFS_OPEN_READ</literal></term>
104
101
<listitem><simpara> Read access.
105
102
</simpara></listitem>
106
103
</varlistentry>
107
 
<varlistentry>
108
 
<term><anchor id="GNOME-VFS-OPEN-WRITE:CAPS" role="constant"/><literal>GNOME_VFS_OPEN_WRITE</literal></term>
 
104
<varlistentry id="GNOME-VFS-OPEN-WRITE:CAPS" role="constant">
 
105
<term><literal>GNOME_VFS_OPEN_WRITE</literal></term>
109
106
<listitem><simpara> Write access.
110
107
</simpara></listitem>
111
108
</varlistentry>
112
 
<varlistentry>
113
 
<term><anchor id="GNOME-VFS-OPEN-RANDOM:CAPS" role="constant"/><literal>GNOME_VFS_OPEN_RANDOM</literal></term>
 
109
<varlistentry id="GNOME-VFS-OPEN-RANDOM:CAPS" role="constant">
 
110
<term><literal>GNOME_VFS_OPEN_RANDOM</literal></term>
114
111
<listitem><simpara> Random access.
115
112
</simpara></listitem>
116
113
</varlistentry>
117
 
<varlistentry>
118
 
<term><anchor id="GNOME-VFS-OPEN-TRUNCATE:CAPS" role="constant"/><literal>GNOME_VFS_OPEN_TRUNCATE</literal></term>
 
114
<varlistentry id="GNOME-VFS-OPEN-TRUNCATE:CAPS" role="constant">
 
115
<term><literal>GNOME_VFS_OPEN_TRUNCATE</literal></term>
119
116
<listitem><simpara> Truncate file before accessing it, i.e. delete its contents.
120
117
</simpara></listitem>
121
118
</varlistentry>
122
119
</variablelist></refsect2>
123
 
<refsect2>
124
 
<title><anchor id="gnome-vfs-create" role="function"/>gnome_vfs_create ()</title>
125
 
<indexterm><primary>gnome_vfs_create</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_create                    (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
 
120
<refsect2 id="gnome-vfs-create" role="function">
 
121
<title>gnome_vfs_create ()</title>
 
122
<indexterm zone="gnome-vfs-create"><primary>gnome_vfs_create</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_create                    (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
126
123
                                                         const <link linkend="gchar">gchar</link> *text_uri,
127
124
                                                         <link linkend="GnomeVFSOpenMode">GnomeVFSOpenMode</link> open_mode,
128
125
                                                         <link linkend="gboolean">gboolean</link> exclusive,
155
152
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
156
153
</simpara></listitem></varlistentry>
157
154
</variablelist></refsect2>
158
 
<refsect2>
159
 
<title><anchor id="gnome-vfs-create-uri" role="function"/>gnome_vfs_create_uri ()</title>
160
 
<indexterm><primary>gnome_vfs_create_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_create_uri                (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
 
155
<refsect2 id="gnome-vfs-create-uri" role="function">
 
156
<title>gnome_vfs_create_uri ()</title>
 
157
<indexterm zone="gnome-vfs-create-uri"><primary>gnome_vfs_create_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_create_uri                (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
161
158
                                                         <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
162
159
                                                         <link linkend="GnomeVFSOpenMode">GnomeVFSOpenMode</link> open_mode,
163
160
                                                         <link linkend="gboolean">gboolean</link> exclusive,
189
186
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
190
187
</simpara></listitem></varlistentry>
191
188
</variablelist></refsect2>
192
 
<refsect2>
193
 
<title><anchor id="gnome-vfs-open" role="function"/>gnome_vfs_open ()</title>
194
 
<indexterm><primary>gnome_vfs_open</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_open                      (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
 
189
<refsect2 id="gnome-vfs-open" role="function">
 
190
<title>gnome_vfs_open ()</title>
 
191
<indexterm zone="gnome-vfs-open"><primary>gnome_vfs_open</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_open                      (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
195
192
                                                         const <link linkend="gchar">gchar</link> *text_uri,
196
193
                                                         <link linkend="GnomeVFSOpenMode">GnomeVFSOpenMode</link> open_mode);</programlisting>
197
194
<para>
212
209
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
213
210
</simpara></listitem></varlistentry>
214
211
</variablelist></refsect2>
215
 
<refsect2>
216
 
<title><anchor id="gnome-vfs-open-uri" role="function"/>gnome_vfs_open_uri ()</title>
217
 
<indexterm><primary>gnome_vfs_open_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_open_uri                  (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
 
212
<refsect2 id="gnome-vfs-open-uri" role="function">
 
213
<title>gnome_vfs_open_uri ()</title>
 
214
<indexterm zone="gnome-vfs-open-uri"><primary>gnome_vfs_open_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_open_uri                  (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> **handle,
218
215
                                                         <link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
219
216
                                                         <link linkend="GnomeVFSOpenMode">GnomeVFSOpenMode</link> open_mode);</programlisting>
220
217
<para>
235
232
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
236
233
</simpara></listitem></varlistentry>
237
234
</variablelist></refsect2>
238
 
<refsect2>
239
 
<title><anchor id="gnome-vfs-close" role="function"/>gnome_vfs_close ()</title>
240
 
<indexterm><primary>gnome_vfs_close</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_close                     (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> *handle);</programlisting>
 
235
<refsect2 id="gnome-vfs-close" role="function">
 
236
<title>gnome_vfs_close ()</title>
 
237
<indexterm zone="gnome-vfs-close"><primary>gnome_vfs_close</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_close                     (<link linkend="GnomeVFSHandle">GnomeVFSHandle</link> *handle);</programlisting>
241
238
<para>
242
239
Close file associated with <parameter>handle</parameter>.</para>
243
240
<para>
249
246
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
250
247
</simpara></listitem></varlistentry>
251
248
</variablelist></refsect2>
252
 
<refsect2>
253
 
<title><anchor id="gnome-vfs-unlink" role="function"/>gnome_vfs_unlink ()</title>
254
 
<indexterm><primary>gnome_vfs_unlink</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_unlink                    (const <link linkend="gchar">gchar</link> *text_uri);</programlisting>
 
249
<refsect2 id="gnome-vfs-unlink" role="function">
 
250
<title>gnome_vfs_unlink ()</title>
 
251
<indexterm zone="gnome-vfs-unlink"><primary>gnome_vfs_unlink</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_unlink                    (const <link linkend="gchar">gchar</link> *text_uri);</programlisting>
255
252
<para>
256
253
Unlink <parameter>text_uri</parameter> (i.e. delete the file).</para>
257
254
<para>
263
260
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
264
261
</simpara></listitem></varlistentry>
265
262
</variablelist></refsect2>
266
 
<refsect2>
267
 
<title><anchor id="gnome-vfs-unlink-from-uri" role="function"/>gnome_vfs_unlink_from_uri ()</title>
268
 
<indexterm><primary>gnome_vfs_unlink_from_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_unlink_from_uri           (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
263
<refsect2 id="gnome-vfs-unlink-from-uri" role="function">
 
264
<title>gnome_vfs_unlink_from_uri ()</title>
 
265
<indexterm zone="gnome-vfs-unlink-from-uri"><primary>gnome_vfs_unlink_from_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_unlink_from_uri           (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
269
266
<para>
270
267
Unlink <parameter>uri</parameter> (i.e. delete the file).</para>
271
268
<para>
277
274
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
278
275
</simpara></listitem></varlistentry>
279
276
</variablelist></refsect2>
280
 
<refsect2>
281
 
<title><anchor id="gnome-vfs-move-uri" role="function"/>gnome_vfs_move_uri ()</title>
282
 
<indexterm><primary>gnome_vfs_move_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_move_uri                  (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *old_uri,
 
277
<refsect2 id="gnome-vfs-move-uri" role="function">
 
278
<title>gnome_vfs_move_uri ()</title>
 
279
<indexterm zone="gnome-vfs-move-uri"><primary>gnome_vfs_move_uri</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_move_uri                  (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *old_uri,
283
280
                                                         <link linkend="GnomeVFSURI">GnomeVFSURI</link> *new_uri,
284
281
                                                         <link linkend="gboolean">gboolean</link> force_replace);</programlisting>
285
282
<para>
302
299
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
303
300
</simpara></listitem></varlistentry>
304
301
</variablelist></refsect2>
305
 
<refsect2>
306
 
<title><anchor id="gnome-vfs-move" role="function"/>gnome_vfs_move ()</title>
307
 
<indexterm><primary>gnome_vfs_move</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_move                      (const <link linkend="gchar">gchar</link> *old_text_uri,
 
302
<refsect2 id="gnome-vfs-move" role="function">
 
303
<title>gnome_vfs_move ()</title>
 
304
<indexterm zone="gnome-vfs-move"><primary>gnome_vfs_move</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_move                      (const <link linkend="gchar">gchar</link> *old_text_uri,
308
305
                                                         const <link linkend="gchar">gchar</link> *new_text_uri,
309
306
                                                         <link linkend="gboolean">gboolean</link> force_replace);</programlisting>
310
307
<para>
327
324
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
328
325
</simpara></listitem></varlistentry>
329
326
</variablelist></refsect2>
330
 
<refsect2>
331
 
<title><anchor id="gnome-vfs-check-same-fs-uris" role="function"/>gnome_vfs_check_same_fs_uris ()</title>
332
 
<indexterm><primary>gnome_vfs_check_same_fs_uris</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_check_same_fs_uris        (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *source_uri,
 
327
<refsect2 id="gnome-vfs-check-same-fs-uris" role="function">
 
328
<title>gnome_vfs_check_same_fs_uris ()</title>
 
329
<indexterm zone="gnome-vfs-check-same-fs-uris"><primary>gnome_vfs_check_same_fs_uris</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_check_same_fs_uris        (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *source_uri,
333
330
                                                         <link linkend="GnomeVFSURI">GnomeVFSURI</link> *target_uri,
334
331
                                                         <link linkend="gboolean">gboolean</link> *same_fs_return);</programlisting>
335
332
<para>
350
347
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
351
348
</simpara></listitem></varlistentry>
352
349
</variablelist></refsect2>
353
 
<refsect2>
354
 
<title><anchor id="gnome-vfs-check-same-fs" role="function"/>gnome_vfs_check_same_fs ()</title>
355
 
<indexterm><primary>gnome_vfs_check_same_fs</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_check_same_fs             (const <link linkend="gchar">gchar</link> *source,
 
350
<refsect2 id="gnome-vfs-check-same-fs" role="function">
 
351
<title>gnome_vfs_check_same_fs ()</title>
 
352
<indexterm zone="gnome-vfs-check-same-fs"><primary>gnome_vfs_check_same_fs</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_check_same_fs             (const <link linkend="gchar">gchar</link> *source,
356
353
                                                         const <link linkend="gchar">gchar</link> *target,
357
354
                                                         <link linkend="gboolean">gboolean</link> *same_fs_return);</programlisting>
358
355
<para>
373
370
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the result of the operation.
374
371
</simpara></listitem></varlistentry>
375
372
</variablelist></refsect2>
376
 
<refsect2>
377
 
<title><anchor id="gnome-vfs-uri-exists" role="function"/>gnome_vfs_uri_exists ()</title>
378
 
<indexterm><primary>gnome_vfs_uri_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_exists                (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
 
373
<refsect2 id="gnome-vfs-uri-exists" role="function">
 
374
<title>gnome_vfs_uri_exists ()</title>
 
375
<indexterm zone="gnome-vfs-uri-exists"><primary>gnome_vfs_uri_exists</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gnome_vfs_uri_exists                (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri);</programlisting>
379
376
<para>
380
377
Check if the uri points to an existing entity.</para>
381
378
<para>
387
384
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if uri exists.
388
385
</simpara></listitem></varlistentry>
389
386
</variablelist></refsect2>
390
 
<refsect2>
391
 
<title><anchor id="gnome-vfs-create-symbolic-link" role="function"/>gnome_vfs_create_symbolic_link ()</title>
392
 
<indexterm><primary>gnome_vfs_create_symbolic_link</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_create_symbolic_link      (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
 
387
<refsect2 id="gnome-vfs-create-symbolic-link" role="function">
 
388
<title>gnome_vfs_create_symbolic_link ()</title>
 
389
<indexterm zone="gnome-vfs-create-symbolic-link"><primary>gnome_vfs_create_symbolic_link</primary></indexterm><programlisting><link linkend="GnomeVFSResult">GnomeVFSResult</link>      gnome_vfs_create_symbolic_link      (<link linkend="GnomeVFSURI">GnomeVFSURI</link> *uri,
393
390
                                                         const <link linkend="gchar">gchar</link> *target_reference);</programlisting>
394
391
<para>
395
392
Creates a symbolic link, or eventually, a uri link (as necessary)