libgnomevfs2-dev 1:2.24.4-1ubuntu2 / usr / share / doc / libgnomevfs2-common / html / gnome-vfs-2.0-gnome-vfs-file-basic-ops.html

This file is indexed.

/usr/share/doc/libgnomevfs2-common/html/gnome-vfs-2.0-gnome-vfs-file-basic-ops.html is in libgnomevfs2-dev 1:2.24.4-1ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Basic File Operations</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
<link rel="up" href="gnome-vfs-basic-file-ops.html" title="File Operations">
<link rel="prev" href="gnome-vfs-basic-file-ops.html" title="File Operations">
<link rel="next" href="gnome-vfs-2.0-gnome-vfs-file-rw-ops.html" title="Reading and Writing Files">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gnome-vfs-basic-file-ops.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gnome-vfs-basic-file-ops.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
<td><a accesskey="n" href="gnome-vfs-2.0-gnome-vfs-file-rw-ops.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gnome-vfs-2.0-gnome-vfs-file-basic-ops.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gnome-vfs-2.0-gnome-vfs-file-basic-ops.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gnome-vfs-2.0-gnome-vfs-file-basic-ops"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-file-basic-ops.top_of_page"></a>Basic File Operations</span></h2>
<p>Basic File Operations — Essential VFS operations. This includes creating, moving and deleting files, opening and closing file handles.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gnome-vfs-2.0-gnome-vfs-file-basic-ops.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode">GnomeVFSOpenMode</a>;
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-create" title="gnome_vfs_create ()">gnome_vfs_create</a>                    (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> **handle</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text_uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode"><span class="type">GnomeVFSOpenMode</span></a> open_mode</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> exclusive</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> perm</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-create-uri" title="gnome_vfs_create_uri ()">gnome_vfs_create_uri</a>                (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> **handle</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode"><span class="type">GnomeVFSOpenMode</span></a> open_mode</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> exclusive</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> perm</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-open" title="gnome_vfs_open ()">gnome_vfs_open</a>                      (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> **handle</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text_uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode"><span class="type">GnomeVFSOpenMode</span></a> open_mode</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-open-uri" title="gnome_vfs_open_uri ()">gnome_vfs_open_uri</a>                  (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> **handle</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode"><span class="type">GnomeVFSOpenMode</span></a> open_mode</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-close" title="gnome_vfs_close ()">gnome_vfs_close</a>                     (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> *handle</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-unlink" title="gnome_vfs_unlink ()">gnome_vfs_unlink</a>                    (<em class="parameter"><code>const <span class="type">gchar</span> *text_uri</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-unlink-from-uri" title="gnome_vfs_unlink_from_uri ()">gnome_vfs_unlink_from_uri</a>           (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-move-uri" title="gnome_vfs_move_uri ()">gnome_vfs_move_uri</a>                  (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *old_uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *new_uri</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> force_replace</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-move" title="gnome_vfs_move ()">gnome_vfs_move</a>                      (<em class="parameter"><code>const <span class="type">gchar</span> *old_text_uri</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *new_text_uri</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> force_replace</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-check-same-fs-uris" title="gnome_vfs_check_same_fs_uris ()">gnome_vfs_check_same_fs_uris</a>        (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *source_uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *target_uri</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> *same_fs_return</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-check-same-fs" title="gnome_vfs_check_same_fs ()">gnome_vfs_check_same_fs</a>             (<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *target</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> *same_fs_return</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-uri-exists" title="gnome_vfs_uri_exists ()">gnome_vfs_uri_exists</a>                (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      <a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#gnome-vfs-create-symbolic-link" title="gnome_vfs_create_symbolic_link ()">gnome_vfs_create_symbolic_link</a>      (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *target_reference</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-file-basic-ops.description"></a><h2>Description</h2>
<p>
GnomeVFS file operations are, for the most part, patterned after
their POSIX equivalents, with the systematic difference that they
accept URIs rather than paths on the local filesystem. This makes
them easy to learn as if you are already familiar with basic commands
such as <code class="function">open()</code>, <code class="function">seek()</code>, <code class="function">write()</code>, etc you will feel right at home
with GnomeVFS after learning a little about URIs.
</p>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-file-basic-ops.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomeVFSOpenMode"></a><h3>enum GnomeVFSOpenMode</h3>
<pre class="programlisting">typedef enum {
        GNOME_VFS_OPEN_NONE = 0,
        GNOME_VFS_OPEN_READ = 1 &lt;&lt; 0,
        GNOME_VFS_OPEN_WRITE = 1 &lt;&lt; 1,
        GNOME_VFS_OPEN_RANDOM = 1 &lt;&lt; 2,
	GNOME_VFS_OPEN_TRUNCATE = 1 &lt;&lt; 3
} GnomeVFSOpenMode;
</pre>
<p>
Mode in which files are opened. If GNOME_VFS_OPEN_RANDOM is not used, the
file will be have to be accessed sequentially.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GNOME-VFS-OPEN-NONE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_OPEN_NONE</code></span></p></td>
<td>No access.
</td>
</tr>
<tr>
<td><p><a name="GNOME-VFS-OPEN-READ:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_OPEN_READ</code></span></p></td>
<td>Read access.
</td>
</tr>
<tr>
<td><p><a name="GNOME-VFS-OPEN-WRITE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_OPEN_WRITE</code></span></p></td>
<td>Write access.
</td>
</tr>
<tr>
<td><p><a name="GNOME-VFS-OPEN-RANDOM:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_OPEN_RANDOM</code></span></p></td>
<td>Random access.
</td>
</tr>
<tr>
<td><p><a name="GNOME-VFS-OPEN-TRUNCATE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_OPEN_TRUNCATE</code></span></p></td>
<td>Truncate file before accessing it, i.e. delete its contents.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-create"></a><h3>gnome_vfs_create ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_create                    (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> **handle</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text_uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode"><span class="type">GnomeVFSOpenMode</span></a> open_mode</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> exclusive</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> perm</code></em>);</pre>
<p>
Create <em class="parameter"><code>text_uri</code></em> according to mode <em class="parameter"><code>open_mode</code></em>.  On return, <em class="parameter"><code>handle</code></em> will then
contain a pointer to a handle for the open file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>pointer to a pointer to a <span class="type">GnomeVFSHandle</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text_uri</code></em> :</span></p></td>
<td>string representing the uri to create.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>open_mode</code></em> :</span></p></td>
<td>mode to leave the file opened in after creation (or <code class="literal">GNOME_VFS_OPEN_MODE_NONE</code>
to leave the file closed after creation).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>exclusive</code></em> :</span></p></td>
<td>whether the file should be created in "exclusive" mode.
i.e. if this flag is nonzero, operation will fail if a file with the
same name already exists.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>perm</code></em> :</span></p></td>
<td>bitmap representing the permissions for the newly created file
(Unix style).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-create-uri"></a><h3>gnome_vfs_create_uri ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_create_uri                (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> **handle</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode"><span class="type">GnomeVFSOpenMode</span></a> open_mode</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> exclusive</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> perm</code></em>);</pre>
<p>
Create <em class="parameter"><code>uri</code></em> according to mode <em class="parameter"><code>open_mode</code></em>.  On return, <em class="parameter"><code>handle</code></em> will then
contain a pointer to a handle for the open file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>pointer to a pointer to a <span class="type">GnomeVFSHandle</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>uri for the file to create.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>open_mode</code></em> :</span></p></td>
<td>open mode.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>exclusive</code></em> :</span></p></td>
<td>whether the file should be created in "exclusive" mode.
i.e. if this flag is nonzero, operation will fail if a file with the
same name already exists.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>perm</code></em> :</span></p></td>
<td>bitmap representing the permissions for the newly created file
(Unix style).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-open"></a><h3>gnome_vfs_open ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_open                      (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> **handle</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text_uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode"><span class="type">GnomeVFSOpenMode</span></a> open_mode</code></em>);</pre>
<p>
Open <em class="parameter"><code>text_uri</code></em> according to mode <em class="parameter"><code>open_mode</code></em>.  On return, <em class="parameter"><code>handle</code></em> will then
contain a pointer to a handle for the open file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>pointer to a pointer to a <span class="type">GnomeVFSHandle</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text_uri</code></em> :</span></p></td>
<td>string representing the uri to open.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>open_mode</code></em> :</span></p></td>
<td>open mode.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-open-uri"></a><h3>gnome_vfs_open_uri ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_open_uri                  (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> **handle</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-basic-ops.html#GnomeVFSOpenMode" title="enum GnomeVFSOpenMode"><span class="type">GnomeVFSOpenMode</span></a> open_mode</code></em>);</pre>
<p>
Open <em class="parameter"><code>uri</code></em> according to mode <em class="parameter"><code>open_mode</code></em>.  On return, <em class="parameter"><code>handle</code></em> will then
contain a pointer to a handle for the open file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>pointer to a pointer to a <span class="type">GnomeVFSHandle</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>uri to open.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>open_mode</code></em> :</span></p></td>
<td>open mode.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-close"></a><h3>gnome_vfs_close ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_close                     (<em class="parameter"><code><span class="type">GnomeVFSHandle</span> *handle</code></em>);</pre>
<p>
Close file associated with <em class="parameter"><code>handle</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>pointer to a <span class="type">GnomeVFSHandle</span> object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-unlink"></a><h3>gnome_vfs_unlink ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_unlink                    (<em class="parameter"><code>const <span class="type">gchar</span> *text_uri</code></em>);</pre>
<p>
Unlink <em class="parameter"><code>text_uri</code></em> (i.e. delete the file).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text_uri</code></em> :</span></p></td>
<td>uri of the file to be unlinked.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-unlink-from-uri"></a><h3>gnome_vfs_unlink_from_uri ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_unlink_from_uri           (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);</pre>
<p>
Unlink <em class="parameter"><code>uri</code></em> (i.e. delete the file).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>uri of the file to be unlinked.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-move-uri"></a><h3>gnome_vfs_move_uri ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_move_uri                  (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *old_uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *new_uri</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> force_replace</code></em>);</pre>
<p>
Move a file from uri <em class="parameter"><code>old_uri</code></em> to <em class="parameter"><code>new_uri</code></em>.  This will only work if <em class="parameter"><code>old_uri</code></em> 
and <em class="parameter"><code>new_uri</code></em> are on the same file system.  Otherwise, it is necessary 
to use the more general <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()"><code class="function">gnome_vfs_xfer_uri()</code></a> function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>old_uri</code></em> :</span></p></td>
<td>source uri.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_uri</code></em> :</span></p></td>
<td>destination uri.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>force_replace</code></em> :</span></p></td>
<td>if <code class="literal">TRUE</code>, move <em class="parameter"><code>old_uri</code></em> to <em class="parameter"><code>new_uri</code></em> even if there
is already a file at <em class="parameter"><code>new_uri</code></em>. If there is a file, it will be discarded.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-move"></a><h3>gnome_vfs_move ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_move                      (<em class="parameter"><code>const <span class="type">gchar</span> *old_text_uri</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *new_text_uri</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> force_replace</code></em>);</pre>
<p>
Move a file from <em class="parameter"><code>old_text_uri</code></em> to <em class="parameter"><code>new_text_uri</code></em>.  This will only work 
if <em class="parameter"><code>old_text_uri</code></em> and <em class="parameter"><code>new_text_uri</code></em> are on the same file system.  Otherwise,
it is necessary to use the more general <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()"><code class="function">gnome_vfs_xfer_uri()</code></a> function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>old_text_uri</code></em> :</span></p></td>
<td>string representing the source file location.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_text_uri</code></em> :</span></p></td>
<td>string representing the destination file location.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>force_replace</code></em> :</span></p></td>
<td>if <code class="literal">TRUE</code>, perform the operation even if it unlinks an existing
file at <em class="parameter"><code>new_text_uri</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-check-same-fs-uris"></a><h3>gnome_vfs_check_same_fs_uris ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_check_same_fs_uris        (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *source_uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *target_uri</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> *same_fs_return</code></em>);</pre>
<p>
Check if <em class="parameter"><code>source_uri</code></em> and <em class="parameter"><code>target_uri</code></em> are on the same file system.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source_uri</code></em> :</span></p></td>
<td>a uri.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target_uri</code></em> :</span></p></td>
<td>another uri.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>same_fs_return</code></em> :</span></p></td>
<td>pointer to a boolean variable which will be set to <code class="literal">TRUE</code>
on return if <em class="parameter"><code>source_uri</code></em> and <em class="parameter"><code>target_uri</code></em> are on the same file system.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-check-same-fs"></a><h3>gnome_vfs_check_same_fs ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_check_same_fs             (<em class="parameter"><code>const <span class="type">gchar</span> *source</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *target</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> *same_fs_return</code></em>);</pre>
<p>
Check if <em class="parameter"><code>source</code></em> and <em class="parameter"><code>target</code></em> are on the same file system.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>path to a file.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>path to another file.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>same_fs_return</code></em> :</span></p></td>
<td>pointer to a boolean variable which will be set to <code class="literal">TRUE</code>
on return if <em class="parameter"><code>source</code></em> and <em class="parameter"><code>target</code></em> are on the same file system.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-uri-exists"></a><h3>gnome_vfs_uri_exists ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gnome_vfs_uri_exists                (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);</pre>
<p>
Check if the uri points to an existing entity.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a uri.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if uri exists.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-create-symbolic-link"></a><h3>gnome_vfs_create_symbolic_link ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      gnome_vfs_create_symbolic_link      (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *target_reference</code></em>);</pre>
<p>
Creates a symbolic link, or eventually, a uri link (as necessary) 
at <em class="parameter"><code>uri</code></em> pointing to <em class="parameter"><code>target_reference</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>uri to create a link at.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target_reference</code></em> :</span></p></td>
<td>uri "reference" to point the link to (uri or relative path).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer representing the result of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.