← Back to branch summary

~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

« back to all changes in this revision

Viewing changes to doc/html/gnome-vfs-20-gnome-vfs-xfer.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-17 16:12:58 UTC
  • mfrom: (0.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317161258-px3a2czt9g2ktjz3
Tags: 1:2.24.1-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/gnome-vfs-20-gnome-vfs-xfer.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>File Transfers</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
8
 
<link rel="up" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
9
 
<link rel="prev" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
10
 
<link rel="next" href="gnome-vfs-20-gnome-vfs-monitor.html" title="Monitoring">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="about.html" title="Introduction to GnomeVFS">
14
 
<link rel="chapter" href="data-types.html" title="Basic Data Types">
15
 
<link rel="chapter" href="gnome-vfs-basic-file-ops.html" title="File Operations">
16
 
<link rel="chapter" href="gnome-vfs-directory-ops.html" title="Directory-Specific Operations">
17
 
<link rel="chapter" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
18
 
<link rel="chapter" href="gnome-vfs-file-async-ops.html" title="Asynchronous Operations">
19
 
<link rel="chapter" href="volumes.html" title="Volumes and Drives Handling">
20
 
<link rel="chapter" href="networking.html" title="Networking">
21
 
<link rel="chapter" href="mime-registry.html" title="MIME Registry">
22
 
<link rel="chapter" href="modules.html" title="Filesystem Modules">
23
 
</head>
24
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
25
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
26
 
<tr valign="middle">
27
 
<td><a accesskey="p" href="gnome-vfs-file-and-dirs-ops.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
28
 
<td><a accesskey="u" href="gnome-vfs-file-and-dirs-ops.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
29
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
30
 
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
31
 
<td><a accesskey="n" href="gnome-vfs-20-gnome-vfs-monitor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
32
 
</tr>
33
 
<tr><td colspan="5" class="shortcuts">
34
 
<a href="#gnome-vfs-20-gnome-vfs-xfer.synopsis" class="shortcut">Top</a>
35
 
                 | 
36
 
                <a href="#gnome-vfs-20-gnome-vfs-xfer.description" class="shortcut">Description</a>
37
 
</td></tr>
38
 
</table>
39
 
<div class="refentry" lang="en">
40
 
<a name="gnome-vfs-20-gnome-vfs-xfer"></a><div class="titlepage"></div>
41
 
<div class="refnamediv"><table width="100%"><tr>
42
 
<td valign="top">
43
 
<h2><span class="refentrytitle"><a name="gnome-vfs-20-gnome-vfs-xfer.top_of_page"></a>File Transfers</span></h2>
44
 
<p>File Transfers — Conveniently copy/move/delete files en masse</p>
45
 
</td>
46
 
<td valign="top" align="right"></td>
47
 
</tr></table></div>
48
 
<div class="refsynopsisdiv">
49
 
<a name="gnome-vfs-20-gnome-vfs-xfer.synopsis"></a><h2>Synopsis</h2>
50
 
<pre class="synopsis">
51
 
enum                <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions">GnomeVFSXferOptions</a>;
52
 
enum                <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus">GnomeVFSXferProgressStatus</a>;
53
 
enum                <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode">GnomeVFSXferOverwriteMode</a>;
54
 
enum                <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOverwriteAction" title="enum GnomeVFSXferOverwriteAction">GnomeVFSXferOverwriteAction</a>;
55
 
enum                <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode">GnomeVFSXferErrorMode</a>;
56
 
enum                <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorAction" title="enum GnomeVFSXferErrorAction">GnomeVFSXferErrorAction</a>;
57
 
enum                <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferPhase" title="enum GnomeVFSXferPhase">GnomeVFSXferPhase</a>;
58
 
                    <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo">GnomeVFSXferProgressInfo</a>;
59
 
gint                (<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()">*GnomeVFSXferProgressCallback</a>)     (<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo">GnomeVFSXferProgressInfo</a> *info,
60
 
                                                         gpointer user_data);
61
 
<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-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()">gnome_vfs_xfer_uri_list</a>             (const GList *source_uri_list,
62
 
                                                         const GList *target_uri_list,
63
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions">GnomeVFSXferOptions</a> xfer_options,
64
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode">GnomeVFSXferErrorMode</a> error_mode,
65
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode">GnomeVFSXferOverwriteMode</a> overwrite_mode,
66
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()">GnomeVFSXferProgressCallback</a> progress_callback,
67
 
                                                         gpointer data);
68
 
<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-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()">gnome_vfs_xfer_uri</a>                  (const <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *source_uri,
69
 
                                                         const <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *target_uri,
70
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions">GnomeVFSXferOptions</a> xfer_options,
71
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode">GnomeVFSXferErrorMode</a> error_mode,
72
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode">GnomeVFSXferOverwriteMode</a> overwrite_mode,
73
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()">GnomeVFSXferProgressCallback</a> progress_callback,
74
 
                                                         gpointer data);
75
 
<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-xfer.html#gnome-vfs-xfer-delete-list" title="gnome_vfs_xfer_delete_list ()">gnome_vfs_xfer_delete_list</a>          (const GList *source_uri_list,
76
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode">GnomeVFSXferErrorMode</a> error_mode,
77
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions">GnomeVFSXferOptions</a> xfer_options,
78
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()">GnomeVFSXferProgressCallback</a> progress_callback,
79
 
                                                         gpointer data);
80
 
</pre>
81
 
</div>
82
 
<div class="refsect1" lang="en">
83
 
<a name="gnome-vfs-20-gnome-vfs-xfer.description"></a><h2>Description</h2>
84
 
<p>
85
 
</p>
86
 
</div>
87
 
<div class="refsect1" lang="en">
88
 
<a name="gnome-vfs-20-gnome-vfs-xfer.details"></a><h2>Details</h2>
89
 
<div class="refsect2" lang="en">
90
 
<a name="GnomeVFSXferOptions"></a><h3>enum GnomeVFSXferOptions</h3>
91
 
<pre class="programlisting">typedef enum {
92
 
        GNOME_VFS_XFER_DEFAULT = 0,
93
 
        GNOME_VFS_XFER_UNUSED_1 = 1 &lt;&lt; 0,
94
 
        GNOME_VFS_XFER_FOLLOW_LINKS = 1 &lt;&lt; 1,
95
 
        GNOME_VFS_XFER_UNUSED_2 = 1 &lt;&lt; 2,
96
 
        GNOME_VFS_XFER_RECURSIVE = 1 &lt;&lt; 3,
97
 
        GNOME_VFS_XFER_SAMEFS = 1 &lt;&lt; 4,
98
 
        GNOME_VFS_XFER_DELETE_ITEMS = 1 &lt;&lt; 5,
99
 
        GNOME_VFS_XFER_EMPTY_DIRECTORIES = 1 &lt;&lt; 6,
100
 
        GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY = 1 &lt;&lt; 7,
101
 
        GNOME_VFS_XFER_REMOVESOURCE = 1 &lt;&lt; 8,
102
 
        GNOME_VFS_XFER_USE_UNIQUE_NAMES = 1 &lt;&lt; 9,
103
 
        GNOME_VFS_XFER_LINK_ITEMS = 1 &lt;&lt; 10,
104
 
        GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE = 1 &lt;&lt; 11,
105
 
        GNOME_VFS_XFER_TARGET_DEFAULT_PERMS = 1 &lt;&lt; 12
106
 
} GnomeVFSXferOptions;
107
 
</pre>
108
 
<p>
109
 
These options control the way <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()"><code class="function">gnome_vfs_xfer_uri()</code></a>, <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()"><code class="function">gnome_vfs_xfer_uri_list()</code></a>,
110
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-delete-list" title="gnome_vfs_xfer_delete_list ()"><code class="function">gnome_vfs_xfer_delete_list()</code></a> and <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a> work.
111
 
</p>
112
 
<p>
113
 
At a first glance the <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> semantics are not very intuitive.
114
 
</p>
115
 
<p>
116
 
There are two types of <span class="type">""</span> Those that define an operation,
117
 
i.e. describe what to do, and those that influence how to execute the
118
 
operation.
119
 
</p>
120
 
<p>
121
 
</p>
122
 
<div class="table">
123
 
<a name="id438684"></a><p class="title"><b>Table 1. Operation Selection</b></p>
124
 
<div class="table-contents"><table summary="Operation Selection" border="0">
125
 
<colgroup>
126
 
<col align="left">
127
 
<col align="left">
128
 
<col align="left">
129
 
</colgroup>
130
 
<thead><tr>
131
 
<th align="left">
132
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> entry</th>
133
 
<th align="left">Operation</th>
134
 
<th align="left">UNIX equivalent</th>
135
 
<th align="left">Comments</th>
136
 
</tr></thead>
137
 
<tbody>
138
 
<tr>
139
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-DEFAULT--CAPS"><span class="type">GNOME_VFS_XFER_DEFAULT</span></a></td>
140
 
<td align="left">Copy</td>
141
 
<td align="left"><code class="literal">cp</code></td>
142
 
</tr>
143
 
<tr>
144
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-REMOVESOURCE--CAPS"><span class="type">GNOME_VFS_XFER_REMOVESOURCE</span></a></td>
145
 
<td align="left">Move</td>
146
 
<td align="left"><code class="literal">mv</code></td>
147
 
</tr>
148
 
<tr>
149
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-LINK-ITEMS--CAPS"><span class="type">GNOME_VFS_XFER_LINK_ITEMS</span></a></td>
150
 
<td align="left">Link</td>
151
 
<td align="left"><code class="literal">ln -s</code></td>
152
 
</tr>
153
 
<tr>
154
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-NEW-UNIQUE-DIRECTORY--CAPS"><span class="type">GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY</span></a></td>
155
 
<td align="left">Make Unique Directory</td>
156
 
<td align="left"><code class="literal">mkdir</code></td>
157
 
<td align="left">implies <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-USE-UNIQUE-NAMES--CAPS"><span class="type">GNOME_VFS_XFER_USE_UNIQUE_NAMES</span></a>
158
 
</td>
159
 
</tr>
160
 
<tr>
161
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-DELETE-ITEMS--CAPS"><span class="type">GNOME_VFS_XFER_DELETE_ITEMS</span></a></td>
162
 
<td align="left">Remove</td>
163
 
<td align="left"><code class="literal">rm -r</code></td>
164
 
<td class="auto-generated"> </td>
165
 
</tr>
166
 
<tr>
167
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-EMPTY-DIRECTORIES--CAPS"><span class="type">GNOME_VFS_XFER_EMPTY_DIRECTORIES</span></a></td>
168
 
<td align="left">Remove Directory Contents</td>
169
 
<td align="left">foreach file: <code class="literal">( cd file &amp;&amp; rm -rf * )</code>
170
 
</td>
171
 
<td align="left">used to empty trash</td>
172
 
</tr>
173
 
</tbody>
174
 
</table></div>
175
 
</div>
176
 
<p><br class="table-break">
177
 
</p>
178
 
<p>
179
 
</p>
180
 
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
181
 
<h3 class="title">Note</h3>
182
 
<p>
183
 
   Because <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-DEFAULT--CAPS"><span class="type">GNOME_VFS_XFER_DEFAULT</span></a> maps to <code class="literal">0</code>, it will always be present.
184
 
   Thus, not explicitly specifying any operation at all, or just specifying
185
 
   <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-DEFAULT--CAPS"><span class="type">GNOME_VFS_XFER_DEFAULT</span></a> will both execute a copy.
186
 
 </p>
187
 
<p>
188
 
   If an operation other than <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-DEFAULT--CAPS"><span class="type">GNOME_VFS_XFER_DEFAULT</span></a> is
189
 
   specified, it will override the copy operation, but you may only specify
190
 
   <span class="emphasis"><em>one</em></span> of the other operations at a time.
191
 
 </p>
192
 
<p>
193
 
   This unintuitive operation selection unfortunately poses an API weakness
194
 
   and an obstacle in client development, and will be modified in a later
195
 
   revision of this API.
196
 
 </p>
197
 
</div>
198
 
<p>
199
 
</p>
200
 
<div class="variablelist"><table border="0">
201
 
<col align="left" valign="top">
202
 
<tbody>
203
 
<tr>
204
 
<td><p><a name="GNOME-VFS-XFER-DEFAULT--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_DEFAULT</code></span></p></td>
205
 
<td> Default behavior, which is to do a straight one to one copy.
206
 
</td>
207
 
</tr>
208
 
<tr>
209
 
<td><p><a name="GNOME-VFS-XFER-UNUSED-1--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_UNUSED_1</code></span></p></td>
210
 
<td> Unused.
211
 
</td>
212
 
</tr>
213
 
<tr>
214
 
<td><p><a name="GNOME-VFS-XFER-FOLLOW-LINKS--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_FOLLOW_LINKS</code></span></p></td>
215
 
<td> Follow symbolic links when copying or moving, i.e.
216
 
                                 the target of symbolic links are copied
217
 
                                 rather than the symbolic links themselves.
218
 
                                 Note that this just refers to top-level items.
219
 
                                 If you also want to follow symbolic links inside
220
 
                                 directories you operate on, you also have to specify
221
 
                                 <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-FOLLOW-LINKS-RECURSIVE--CAPS"><span class="type">GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE</span></a>.
222
 
</td>
223
 
</tr>
224
 
<tr>
225
 
<td><p><a name="GNOME-VFS-XFER-UNUSED-2--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_UNUSED_2</code></span></p></td>
226
 
<td> Unused.
227
 
</td>
228
 
</tr>
229
 
<tr>
230
 
<td><p><a name="GNOME-VFS-XFER-RECURSIVE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_RECURSIVE</code></span></p></td>
231
 
<td> Recursively copy source directories to the target. 
232
 
                              Equivalent to the cp -r option in GNU cp.
233
 
</td>
234
 
</tr>
235
 
<tr>
236
 
<td><p><a name="GNOME-VFS-XFER-SAMEFS--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_SAMEFS</code></span></p></td>
237
 
<td> When copying recursively, this only picks up items on the same file
238
 
                           system the same filesystem as their parent directory.
239
 
</td>
240
 
</tr>
241
 
<tr>
242
 
<td><p><a name="GNOME-VFS-XFER-DELETE-ITEMS--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_DELETE_ITEMS</code></span></p></td>
243
 
<td> This is equivalent to an <code class="function">rmdir()</code> for source directories,
244
 
                                 and an <code class="function">unlink()</code> operation for all source files.
245
 
                                 Requires <code class="literal">NULL</code> target URIs.
246
 
</td>
247
 
</tr>
248
 
<tr>
249
 
<td><p><a name="GNOME-VFS-XFER-EMPTY-DIRECTORIES--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_EMPTY_DIRECTORIES</code></span></p></td>
250
 
<td> Remove the whole contents of the passed-in source
251
 
                                      directories. Requires <code class="literal">NULL</code> target URIs.
252
 
</td>
253
 
</tr>
254
 
<tr>
255
 
<td><p><a name="GNOME-VFS-XFER-NEW-UNIQUE-DIRECTORY--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY</code></span></p></td>
256
 
<td> This will create a directory if it doesn't exist
257
 
                                         in the destination area (i.e. <code class="function">mkdir()</code>).
258
 
</td>
259
 
</tr>
260
 
<tr>
261
 
<td><p><a name="GNOME-VFS-XFER-REMOVESOURCE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_REMOVESOURCE</code></span></p></td>
262
 
<td> This makes a copy operation equivalent to a mv, i.e. the
263
 
                                 files will be moved rather than copied. If applicable, this
264
 
                                 will use <code class="function">rename()</code>, otherwise (i.e. across file systems),
265
 
                                 it will fall back to a copy operation followed by a source
266
 
                                 file deletion.
267
 
</td>
268
 
</tr>
269
 
<tr>
270
 
<td><p><a name="GNOME-VFS-XFER-USE-UNIQUE-NAMES--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_USE_UNIQUE_NAMES</code></span></p></td>
271
 
<td> When this option is present, and a name collisions on
272
 
                                     the target occurs, the progress callback will be asked
273
 
                                     for a new name, until the newly provided name doesn't
274
 
                                     conflict or the request callback transfer cancellation.
275
 
</td>
276
 
</tr>
277
 
<tr>
278
 
<td><p><a name="GNOME-VFS-XFER-LINK-ITEMS--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_LINK_ITEMS</code></span></p></td>
279
 
<td> Executes a symlink operation for each of the source/target URI pairs,
280
 
                               i.e. similar to GNU ln -s source target.
281
 
                               NB: The symlink target has to be specified as source URI,
282
 
                                   and the symlink itself as target URI.
283
 
</td>
284
 
</tr>
285
 
<tr>
286
 
<td><p><a name="GNOME-VFS-XFER-FOLLOW-LINKS-RECURSIVE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE</code></span></p></td>
287
 
<td> This means that when doing a copy operation, symbolic
288
 
                                           links in subdirectories are dereferenced. This is
289
 
                                           typically used together with <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-FOLLOW-LINKS-RECURSIVE--CAPS"><span class="type">GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE</span></a>.
290
 
</td>
291
 
</tr>
292
 
<tr>
293
 
<td><p><a name="GNOME-VFS-XFER-TARGET-DEFAULT-PERMS--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_TARGET_DEFAULT_PERMS</code></span></p></td>
294
 
<td> This means that the target file will not have the same
295
 
                                         permissions as the source file, but will instead have
296
 
                                         the default permissions of the destination location.
297
 
                                         This is useful when copying from read-only locations (CDs).
298
 
</td>
299
 
</tr>
300
 
</tbody>
301
 
</table></div>
302
 
</div>
303
 
<hr>
304
 
<div class="refsect2" lang="en">
305
 
<a name="GnomeVFSXferProgressStatus"></a><h3>enum GnomeVFSXferProgressStatus</h3>
306
 
<pre class="programlisting">typedef enum {
307
 
        GNOME_VFS_XFER_PROGRESS_STATUS_OK = 0,
308
 
        GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR = 1,
309
 
        GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE = 2,
310
 
        GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE = 3
311
 
} GnomeVFSXferProgressStatus;
312
 
</pre>
313
 
<p>
314
 
The difference between <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-OVERWRITE--CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE</span></a> and
315
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-DUPLICATE--CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE</span></a> is that they will be issued
316
 
at different occassions, and that the return value will be interpreted
317
 
differently. For details, see <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a>.</p>
318
 
<p>
319
 
</p>
320
 
<div class="variablelist"><table border="0">
321
 
<col align="left" valign="top">
322
 
<tbody>
323
 
<tr>
324
 
<td><p><a name="GNOME-VFS-XFER-PROGRESS-STATUS-OK--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PROGRESS_STATUS_OK</code></span></p></td>
325
 
<td> The file transfer is progressing normally.
326
 
</td>
327
 
</tr>
328
 
<tr>
329
 
<td><p><a name="GNOME-VFS-XFER-PROGRESS-STATUS-VFSERROR--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR</code></span></p></td>
330
 
<td> A VFS error was detected.
331
 
</td>
332
 
</tr>
333
 
<tr>
334
 
<td><p><a name="GNOME-VFS-XFER-PROGRESS-STATUS-OVERWRITE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE</code></span></p></td>
335
 
<td> The current target file specified by the
336
 
                                              <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a>'s <code class="literal">target_name</code>
337
 
                                              field already exists.
338
 
</td>
339
 
</tr>
340
 
<tr>
341
 
<td><p><a name="GNOME-VFS-XFER-PROGRESS-STATUS-DUPLICATE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE</code></span></p></td>
342
 
<td> The current target file specified by the
343
 
                                              <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a>'s <code class="literal">target_name</code>
344
 
                                              field already exists, and the progress
345
 
                                              callback is asked to supply a new unique name.
346
 
</td>
347
 
</tr>
348
 
</tbody>
349
 
</table></div>
350
 
</div>
351
 
<hr>
352
 
<div class="refsect2" lang="en">
353
 
<a name="GnomeVFSXferOverwriteMode"></a><h3>enum GnomeVFSXferOverwriteMode</h3>
354
 
<pre class="programlisting">typedef enum {
355
 
        GNOME_VFS_XFER_OVERWRITE_MODE_ABORT = 0,
356
 
        GNOME_VFS_XFER_OVERWRITE_MODE_QUERY = 1,
357
 
        GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE = 2,
358
 
        GNOME_VFS_XFER_OVERWRITE_MODE_SKIP = 3
359
 
} GnomeVFSXferOverwriteMode;
360
 
</pre>
361
 
<p>
362
 
This is passed to <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()"><code class="function">gnome_vfs_xfer_uri()</code></a>, <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()"><code class="function">gnome_vfs_xfer_uri_list()</code></a>,
363
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-delete-list" title="gnome_vfs_xfer_delete_list ()"><code class="function">gnome_vfs_xfer_delete_list()</code></a> and <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a> and specifies
364
 
what action should be taken when a target file already exists.</p>
365
 
<p>
366
 
</p>
367
 
<div class="variablelist"><table border="0">
368
 
<col align="left" valign="top">
369
 
<tbody>
370
 
<tr>
371
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-MODE-ABORT--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_MODE_ABORT</code></span></p></td>
372
 
<td> Abort the transfer when a target file already exists,
373
 
                                         returning the error <span class="type">GNOME_VFS_ERROR_FILEEXISTS</span>.
374
 
</td>
375
 
</tr>
376
 
<tr>
377
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-MODE-QUERY--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_MODE_QUERY</code></span></p></td>
378
 
<td> Query the progress callback with the
379
 
                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a>'s status field
380
 
                                         set to <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-VFSERROR--CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR</span></a> when
381
 
                                         a target file already exists.
382
 
</td>
383
 
</tr>
384
 
<tr>
385
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-MODE-REPLACE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE</code></span></p></td>
386
 
<td> Replace existing target files silently.
387
 
                                           Don't worry be happy.
388
 
</td>
389
 
</tr>
390
 
<tr>
391
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-MODE-SKIP--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_MODE_SKIP</code></span></p></td>
392
 
<td> Skip source files when its target already exists.
393
 
</td>
394
 
</tr>
395
 
</tbody>
396
 
</table></div>
397
 
</div>
398
 
<hr>
399
 
<div class="refsect2" lang="en">
400
 
<a name="GnomeVFSXferOverwriteAction"></a><h3>enum GnomeVFSXferOverwriteAction</h3>
401
 
<pre class="programlisting">typedef enum {
402
 
        GNOME_VFS_XFER_OVERWRITE_ACTION_ABORT = 0,
403
 
        GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE = 1,
404
 
        GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE_ALL = 2,
405
 
        GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP = 3,
406
 
        GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP_ALL = 4
407
 
} GnomeVFSXferOverwriteAction;
408
 
</pre>
409
 
<p>
410
 
This defines the actions to perform before a file is being overwritten
411
 
(i.e., these are the answers that can be given to a replace query).</p>
412
 
<p>
413
 
</p>
414
 
<div class="variablelist"><table border="0">
415
 
<col align="left" valign="top">
416
 
<tbody>
417
 
<tr>
418
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-ACTION-ABORT--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_ACTION_ABORT</code></span></p></td>
419
 
<td> abort the transfer
420
 
</td>
421
 
</tr>
422
 
<tr>
423
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-ACTION-REPLACE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE</code></span></p></td>
424
 
<td> replace the existing file
425
 
</td>
426
 
</tr>
427
 
<tr>
428
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-ACTION-REPLACE-ALL--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE_ALL</code></span></p></td>
429
 
<td> replace the existing file, and all future files
430
 
without prompting the callback.
431
 
</td>
432
 
</tr>
433
 
<tr>
434
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-ACTION-SKIP--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP</code></span></p></td>
435
 
<td> don't copy over the existing file
436
 
</td>
437
 
</tr>
438
 
<tr>
439
 
<td><p><a name="GNOME-VFS-XFER-OVERWRITE-ACTION-SKIP-ALL--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP_ALL</code></span></p></td>
440
 
<td> don't copy over the existing file, and all future
441
 
files without prompting the callback.
442
 
</td>
443
 
</tr>
444
 
</tbody>
445
 
</table></div>
446
 
</div>
447
 
<hr>
448
 
<div class="refsect2" lang="en">
449
 
<a name="GnomeVFSXferErrorMode"></a><h3>enum GnomeVFSXferErrorMode</h3>
450
 
<pre class="programlisting">typedef enum {
451
 
        GNOME_VFS_XFER_ERROR_MODE_ABORT = 0,
452
 
        GNOME_VFS_XFER_ERROR_MODE_QUERY = 1
453
 
} GnomeVFSXferErrorMode;
454
 
</pre>
455
 
<p>
456
 
This is passed to <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()"><code class="function">gnome_vfs_xfer_uri()</code></a>, <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()"><code class="function">gnome_vfs_xfer_uri_list()</code></a>,
457
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-delete-list" title="gnome_vfs_xfer_delete_list ()"><code class="function">gnome_vfs_xfer_delete_list()</code></a> and <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a> and specifies
458
 
what action should be taken when transfer errors are detected.
459
 
</p>
460
 
<p>
461
 
The progress callback is either a <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> for synchronous
462
 
Xfer operations, or a <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#GnomeVFSAsyncXferProgressCallback" title="GnomeVFSAsyncXferProgressCallback ()"><span class="type">GnomeVFSAsyncXferProgressCallback</span></a> for asynchronous operations.</p>
463
 
<p>
464
 
</p>
465
 
<div class="variablelist"><table border="0">
466
 
<col align="left" valign="top">
467
 
<tbody>
468
 
<tr>
469
 
<td><p><a name="GNOME-VFS-XFER-ERROR-MODE-ABORT--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_ERROR_MODE_ABORT</code></span></p></td>
470
 
<td> abort the transfer when an error occurs
471
 
</td>
472
 
</tr>
473
 
<tr>
474
 
<td><p><a name="GNOME-VFS-XFER-ERROR-MODE-QUERY--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_ERROR_MODE_QUERY</code></span></p></td>
475
 
<td> query the progress callback with the
476
 
                                     <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a>'s status field
477
 
                                     set to <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-VFSERROR--CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR</span></a>.
478
 
</td>
479
 
</tr>
480
 
</tbody>
481
 
</table></div>
482
 
</div>
483
 
<hr>
484
 
<div class="refsect2" lang="en">
485
 
<a name="GnomeVFSXferErrorAction"></a><h3>enum GnomeVFSXferErrorAction</h3>
486
 
<pre class="programlisting">typedef enum {
487
 
        GNOME_VFS_XFER_ERROR_ACTION_ABORT = 0,
488
 
        GNOME_VFS_XFER_ERROR_ACTION_RETRY = 1,
489
 
        GNOME_VFS_XFER_ERROR_ACTION_SKIP = 2
490
 
} GnomeVFSXferErrorAction;
491
 
</pre>
492
 
<p>
493
 
This defines the possible actions to be performed after a VFS error has occurred, i.e.
494
 
when a GnomeVFS file operation issued during the transfer returned a result that is not
495
 
equal to <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK--CAPS"><span class="type">GNOME_VFS_OK</span></a>.
496
 
</p>
497
 
<p>
498
 
It is returned by the progress callback which is either a <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a>
499
 
for synchronous Xfer operations, or a <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#GnomeVFSAsyncXferProgressCallback" title="GnomeVFSAsyncXferProgressCallback ()"><span class="type">GnomeVFSAsyncXferProgressCallback</span></a> for asynchronous
500
 
operations.</p>
501
 
<p>
502
 
</p>
503
 
<div class="variablelist"><table border="0">
504
 
<col align="left" valign="top">
505
 
<tbody>
506
 
<tr>
507
 
<td><p><a name="GNOME-VFS-XFER-ERROR-ACTION-ABORT--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_ERROR_ACTION_ABORT</code></span></p></td>
508
 
<td> interrupt Xfer and return <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-INTERRUPTED--CAPS"><code class="literal">GNOME_VFS_ERROR_INTERRUPTED</code></a>.
509
 
</td>
510
 
</tr>
511
 
<tr>
512
 
<td><p><a name="GNOME-VFS-XFER-ERROR-ACTION-RETRY--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_ERROR_ACTION_RETRY</code></span></p></td>
513
 
<td> retry the failed operation.
514
 
</td>
515
 
</tr>
516
 
<tr>
517
 
<td><p><a name="GNOME-VFS-XFER-ERROR-ACTION-SKIP--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_ERROR_ACTION_SKIP</code></span></p></td>
518
 
<td> skip the failed operation, and continue Xfer normally.
519
 
</td>
520
 
</tr>
521
 
</tbody>
522
 
</table></div>
523
 
</div>
524
 
<hr>
525
 
<div class="refsect2" lang="en">
526
 
<a name="GnomeVFSXferPhase"></a><h3>enum GnomeVFSXferPhase</h3>
527
 
<pre class="programlisting">typedef enum {
528
 
        GNOME_VFS_XFER_PHASE_INITIAL,
529
 
        GNOME_VFS_XFER_CHECKING_DESTINATION,
530
 
        GNOME_VFS_XFER_PHASE_COLLECTING,
531
 
        GNOME_VFS_XFER_PHASE_READYTOGO,
532
 
        GNOME_VFS_XFER_PHASE_OPENSOURCE,
533
 
        GNOME_VFS_XFER_PHASE_OPENTARGET,
534
 
        GNOME_VFS_XFER_PHASE_COPYING,
535
 
        GNOME_VFS_XFER_PHASE_MOVING,
536
 
        GNOME_VFS_XFER_PHASE_READSOURCE,
537
 
        GNOME_VFS_XFER_PHASE_WRITETARGET,
538
 
        GNOME_VFS_XFER_PHASE_CLOSESOURCE,
539
 
        GNOME_VFS_XFER_PHASE_CLOSETARGET,
540
 
        GNOME_VFS_XFER_PHASE_DELETESOURCE,
541
 
        GNOME_VFS_XFER_PHASE_SETATTRIBUTES,
542
 
        GNOME_VFS_XFER_PHASE_FILECOMPLETED,
543
 
        GNOME_VFS_XFER_PHASE_CLEANUP,
544
 
        GNOME_VFS_XFER_PHASE_COMPLETED,
545
 
        GNOME_VFS_XFER_NUM_PHASES
546
 
} GnomeVFSXferPhase;
547
 
</pre>
548
 
<p>
549
 
Specifies the current phase of an Xfer operation that was
550
 
initiated using <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()"><code class="function">gnome_vfs_xfer_uri()</code></a>, <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()"><code class="function">gnome_vfs_xfer_uri_list()</code></a>,
551
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-delete-list" title="gnome_vfs_xfer_delete_list ()"><code class="function">gnome_vfs_xfer_delete_list()</code></a> or <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a>.
552
 
</p>
553
 
<p>
554
 
Whenever the Xfer phase is in a phase that is highlighted with a
555
 
(*), the <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> respectively
556
 
<a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#GnomeVFSAsyncXferProgressCallback" title="GnomeVFSAsyncXferProgressCallback ()"><span class="type">GnomeVFSAsyncXferProgressCallback</span></a> is never invoked with a
557
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus"><span class="type">GnomeVFSXferProgressStatus</span></a> other than <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-OK--CAPS"><code class="literal">GNOME_VFS_XFER_PROGRESS_STATUS_OK</code></a>.</p>
558
 
<p>
559
 
</p>
560
 
<div class="variablelist"><table border="0">
561
 
<col align="left" valign="top">
562
 
<tbody>
563
 
<tr>
564
 
<td><p><a name="GNOME-VFS-XFER-PHASE-INITIAL--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_INITIAL</code></span></p></td>
565
 
<td> initial phase.
566
 
</td>
567
 
</tr>
568
 
<tr>
569
 
<td><p><a name="GNOME-VFS-XFER-CHECKING-DESTINATION--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_CHECKING_DESTINATION</code></span></p></td>
570
 
<td> destination is checked for being able to handle copy/move.
571
 
</td>
572
 
</tr>
573
 
<tr>
574
 
<td><p><a name="GNOME-VFS-XFER-PHASE-COLLECTING--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_COLLECTING</code></span></p></td>
575
 
<td> source file list is collected.
576
 
</td>
577
 
</tr>
578
 
<tr>
579
 
<td><p><a name="GNOME-VFS-XFER-PHASE-READYTOGO--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_READYTOGO</code></span></p></td>
580
 
<td> source file list has been collected (*).
581
 
</td>
582
 
</tr>
583
 
<tr>
584
 
<td><p><a name="GNOME-VFS-XFER-PHASE-OPENSOURCE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_OPENSOURCE</code></span></p></td>
585
 
<td> source file is opened for reading.
586
 
</td>
587
 
</tr>
588
 
<tr>
589
 
<td><p><a name="GNOME-VFS-XFER-PHASE-OPENTARGET--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_OPENTARGET</code></span></p></td>
590
 
<td> target file, directory or symlink is created, or opened for copying.
591
 
</td>
592
 
</tr>
593
 
<tr>
594
 
<td><p><a name="GNOME-VFS-XFER-PHASE-COPYING--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_COPYING</code></span></p></td>
595
 
<td> data is copied from source file to target file (*).
596
 
</td>
597
 
</tr>
598
 
<tr>
599
 
<td><p><a name="GNOME-VFS-XFER-PHASE-MOVING--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_MOVING</code></span></p></td>
600
 
<td> source file is moved to target (M).
601
 
</td>
602
 
</tr>
603
 
<tr>
604
 
<td><p><a name="GNOME-VFS-XFER-PHASE-READSOURCE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_READSOURCE</code></span></p></td>
605
 
<td> data is read from a source file, when copying.
606
 
</td>
607
 
</tr>
608
 
<tr>
609
 
<td><p><a name="GNOME-VFS-XFER-PHASE-WRITETARGET--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_WRITETARGET</code></span></p></td>
610
 
<td> data is written to a target file, when copying.
611
 
</td>
612
 
</tr>
613
 
<tr>
614
 
<td><p><a name="GNOME-VFS-XFER-PHASE-CLOSESOURCE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_CLOSESOURCE</code></span></p></td>
615
 
<td> source file is closed, when copying
616
 
</td>
617
 
</tr>
618
 
<tr>
619
 
<td><p><a name="GNOME-VFS-XFER-PHASE-CLOSETARGET--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_CLOSETARGET</code></span></p></td>
620
 
<td> target file is closed, when copying.
621
 
</td>
622
 
</tr>
623
 
<tr>
624
 
<td><p><a name="GNOME-VFS-XFER-PHASE-DELETESOURCE--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_DELETESOURCE</code></span></p></td>
625
 
<td> source file is deleted.
626
 
</td>
627
 
</tr>
628
 
<tr>
629
 
<td><p><a name="GNOME-VFS-XFER-PHASE-SETATTRIBUTES--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_SETATTRIBUTES</code></span></p></td>
630
 
<td> target file attributes are set.
631
 
</td>
632
 
</tr>
633
 
<tr>
634
 
<td><p><a name="GNOME-VFS-XFER-PHASE-FILECOMPLETED--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_FILECOMPLETED</code></span></p></td>
635
 
<td> one file was completed, ready for next file.
636
 
</td>
637
 
</tr>
638
 
<tr>
639
 
<td><p><a name="GNOME-VFS-XFER-PHASE-CLEANUP--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_CLEANUP</code></span></p></td>
640
 
<td> cleanup after moving (i.e. source files deletion).
641
 
</td>
642
 
</tr>
643
 
<tr>
644
 
<td><p><a name="GNOME-VFS-XFER-PHASE-COMPLETED--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_PHASE_COMPLETED</code></span></p></td>
645
 
<td> operation finished (*).
646
 
</td>
647
 
</tr>
648
 
<tr>
649
 
<td><p><a name="GNOME-VFS-XFER-NUM-PHASES--CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_NUM_PHASES</code></span></p></td>
650
 
<td>
651
 
</td>
652
 
</tr>
653
 
</tbody>
654
 
</table></div>
655
 
</div>
656
 
<hr>
657
 
<div class="refsect2" lang="en">
658
 
<a name="GnomeVFSXferProgressInfo"></a><h3>GnomeVFSXferProgressInfo</h3>
659
 
<pre class="programlisting">typedef struct {
660
 
        GnomeVFSXferProgressStatus status;
661
 
 
662
 
        GnomeVFSResult vfs_status;
663
 
 
664
 
        GnomeVFSXferPhase phase;
665
 
 
666
 
        /* Source URI. FIXME bugzilla.eazel.com 1206: change name? */
667
 
        gchar *source_name;
668
 
 
669
 
        /* Destination URI. FIXME bugzilla.eazel.com 1206: change name? */
670
 
        gchar *target_name;
671
 
 
672
 
        gulong file_index;
673
 
 
674
 
        gulong files_total;
675
 
 
676
 
        GnomeVFSFileSize bytes_total;
677
 
 
678
 
        GnomeVFSFileSize file_size;
679
 
 
680
 
        GnomeVFSFileSize bytes_copied;
681
 
 
682
 
        GnomeVFSFileSize total_bytes_copied;
683
 
 
684
 
        gchar *duplicate_name;
685
 
 
686
 
        int duplicate_count;
687
 
 
688
 
        gboolean top_level_item;
689
 
 
690
 
        /* Reserved for future expansions to GnomeVFSXferProgressInfo
691
 
         * without having to break ABI compatibility */
692
 
} GnomeVFSXferProgressInfo;
693
 
</pre>
694
 
<p>
695
 
Provides progress information for the transfer operation.
696
 
This is especially useful for interactive programs.</p>
697
 
<p>
698
 
</p>
699
 
<div class="variablelist"><table border="0">
700
 
<col align="left" valign="top">
701
 
<tbody>
702
 
<tr>
703
 
<td><p><span class="term"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus">GnomeVFSXferProgressStatus</a> <em class="structfield"><code>status</code></em>;</span></p></td>
704
 
<td> A <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus"><span class="type">GnomeVFSXferProgressStatus</span></a> describing the current status.
705
 
</td>
706
 
</tr>
707
 
<tr>
708
 
<td><p><span class="term"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a> <em class="structfield"><code>vfs_status</code></em>;</span></p></td>
709
 
<td> A <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="type">GnomeVFSResult</span></a> describing the current VFS status.
710
 
</td>
711
 
</tr>
712
 
<tr>
713
 
<td><p><span class="term"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferPhase" title="enum GnomeVFSXferPhase">GnomeVFSXferPhase</a> <em class="structfield"><code>phase</code></em>;</span></p></td>
714
 
<td> A <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferPhase" title="enum GnomeVFSXferPhase"><span class="type">GnomeVFSXferPhase</span></a> describing the current transfer phase.
715
 
</td>
716
 
</tr>
717
 
<tr>
718
 
<td><p><span class="term">gchar *<em class="structfield"><code>source_name</code></em>;</span></p></td>
719
 
<td> The Currently processed source URI.
720
 
</td>
721
 
</tr>
722
 
<tr>
723
 
<td><p><span class="term">gchar *<em class="structfield"><code>target_name</code></em>;</span></p></td>
724
 
<td> The Currently processed target URI.
725
 
</td>
726
 
</tr>
727
 
<tr>
728
 
<td><p><span class="term">gulong <em class="structfield"><code>file_index</code></em>;</span></p></td>
729
 
<td> The index of the currently processed file.
730
 
</td>
731
 
</tr>
732
 
<tr>
733
 
<td><p><span class="term">gulong <em class="structfield"><code>files_total</code></em>;</span></p></td>
734
 
<td> The total number of processed files.
735
 
</td>
736
 
</tr>
737
 
<tr>
738
 
<td><p><span class="term"><a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> <em class="structfield"><code>bytes_total</code></em>;</span></p></td>
739
 
<td> The total size of all files to transfer in bytes.
740
 
</td>
741
 
</tr>
742
 
<tr>
743
 
<td><p><span class="term"><a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> <em class="structfield"><code>file_size</code></em>;</span></p></td>
744
 
<td> The size of the currently processed file in bytes.
745
 
</td>
746
 
</tr>
747
 
<tr>
748
 
<td><p><span class="term"><a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> <em class="structfield"><code>bytes_copied</code></em>;</span></p></td>
749
 
<td> The number of bytes that has been transferred
750
 
                  from the current file.
751
 
</td>
752
 
</tr>
753
 
<tr>
754
 
<td><p><span class="term"><a class="link" href="gnome-vfs-20-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize">GnomeVFSFileSize</a> <em class="structfield"><code>total_bytes_copied</code></em>;</span></p></td>
755
 
<td> The total number of bytes that has been transferred.
756
 
</td>
757
 
</tr>
758
 
<tr>
759
 
<td><p><span class="term">gchar *<em class="structfield"><code>duplicate_name</code></em>;</span></p></td>
760
 
<td> The name specifying a duplicate filename.
761
 
                    It acts as pointer to both input and output
762
 
                    data. It is only valid input data if <em class="parameter"><code>status</code></em> is
763
 
                    GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE,
764
 
                    in which case <em class="parameter"><code>duplicate_count</code></em> and <em class="parameter"><code>duplicate_name</code></em>
765
 
                    should be used by the <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a>
766
 
                    to pick a new unique target name.
767
 
                    If the callback wants to retry with a new unique name
768
 
                    it is supposed to free the old <em class="parameter"><code>duplicate_name</code></em>
769
 
                    set it to a valid string describing the new file name.
770
 
</td>
771
 
</tr>
772
 
<tr>
773
 
<td><p><span class="term">int <em class="structfield"><code>duplicate_count</code></em>;</span></p></td>
774
 
<td> The number of conflicts that ocurred when the
775
 
                     current <em class="parameter"><code>duplicate_name</code></em> was set.
776
 
</td>
777
 
</tr>
778
 
<tr>
779
 
<td><p><span class="term">gboolean <em class="structfield"><code>top_level_item</code></em>;</span></p></td>
780
 
<td> This flag signals that the currently
781
 
                    processed file is a top level item.
782
 
                    If it is <code class="literal">TRUE</code>, one of the files passed to
783
 
                    <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()"><code class="function">gnome_vfs_xfer_uri()</code></a>, <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()"><code class="function">gnome_vfs_xfer_uri_list()</code></a>,
784
 
                    <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-delete-list" title="gnome_vfs_xfer_delete_list ()"><code class="function">gnome_vfs_xfer_delete_list()</code></a> or <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a>
785
 
                    is currently processed.
786
 
                    If it is <code class="literal">FALSE</code>, a file or directory that is inside
787
 
                    a directory specified by the passed in source list
788
 
                    is currently processed.
789
 
</td>
790
 
</tr>
791
 
</tbody>
792
 
</table></div>
793
 
</div>
794
 
<hr>
795
 
<div class="refsect2" lang="en">
796
 
<a name="GnomeVFSXferProgressCallback"></a><h3>GnomeVFSXferProgressCallback ()</h3>
797
 
<pre class="programlisting">gint                (*GnomeVFSXferProgressCallback)     (<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo">GnomeVFSXferProgressInfo</a> *info,
798
 
                                                         gpointer user_data);</pre>
799
 
<p>
800
 
This is the prototype for functions called during a transfer operation to
801
 
report progress.
802
 
</p>
803
 
<p>
804
 
The interpretation of the return value of the callback depends on the
805
 
GnomeVFSXferProgressStaus <code class="literal">status</code> field of GnomeVFSXferProgressInfo,
806
 
some status/return value combinations require modification of
807
 
particular <em class="parameter"><code>info</code></em> fields.
808
 
</p>
809
 
<p>
810
 
</p>
811
 
<div class="table">
812
 
<a name="id441269"></a><p class="title"><b>Table 2. Status/Return Value Overview</b></p>
813
 
<div class="table-contents"><table summary="Status/Return Value Overview" border="0">
814
 
<colgroup>
815
 
<col align="left">
816
 
<col align="left">
817
 
<col align="left">
818
 
</colgroup>
819
 
<thead><tr>
820
 
<th align="left">
821
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus"><span class="type">GnomeVFSXferProgressStatus</span></a> status</th>
822
 
<th align="left">Status</th>
823
 
<th align="left">Only If</th>
824
 
<th align="left">Return Value Interpretation</th>
825
 
</tr></thead>
826
 
<tbody>
827
 
<tr>
828
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-OK--CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_OK</span></a></td>
829
 
<td align="left">OK</td>
830
 
<td align="left"> </td>
831
 
<td align="left">
832
 
<code class="literal">0</code>: abort, otherwise continue</td>
833
 
</tr>
834
 
<tr>
835
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-VFSERROR--CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR</span></a></td>
836
 
<td align="left">VFS Error Ocurred</td>
837
 
<td align="left">
838
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode"><span class="type">GnomeVFSXferErrorMode</span></a> is <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-ERROR-MODE-QUERY--CAPS"><span class="type">GNOME_VFS_XFER_ERROR_MODE_QUERY</span></a>
839
 
</td>
840
 
<td align="left">GnomeVFSXferErrorAction</td>
841
 
</tr>
842
 
<tr>
843
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-OVERWRITE--CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE</span></a></td>
844
 
<td align="left">Conflict Ocurred, Overwrite?</td>
845
 
<td align="left">
846
 
           <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode"><span class="type">GnomeVFSXferOverwriteMode</span></a> is <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-OVERWRITE-MODE-QUERY--CAPS"><span class="type">GNOME_VFS_XFER_OVERWRITE_MODE_QUERY</span></a>,
847
 
           <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> does not have <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-USE-UNIQUE-NAMES--CAPS"><span class="type">GNOME_VFS_XFER_USE_UNIQUE_NAMES</span></a>.
848
 
    </td>
849
 
<td align="left">GnomeVFSXferOverwriteAction</td>
850
 
</tr>
851
 
<tr>
852
 
<td align="left"><a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-DUPLICATE--CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE</span></a></td>
853
 
<td align="left">Conflict Ocurred, New Target Name?</td>
854
 
<td align="left">
855
 
<a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> does have <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GNOME-VFS-XFER-USE-UNIQUE-NAMES--CAPS"><span class="type">GNOME_VFS_XFER_USE_UNIQUE_NAMES</span></a>.</td>
856
 
<td align="left">
857
 
<code class="literal">0</code>: abort, otherwise retry with new <code class="literal">duplicate_name</code> in <em class="parameter"><code>info</code></em> (free the old one!).</td>
858
 
</tr>
859
 
</tbody>
860
 
</table></div>
861
 
</div>
862
 
<p><br class="table-break">
863
 
</p>
864
 
<p>
865
 
</p>
866
 
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
867
 
<h3 class="title">Note</h3>
868
 
Each <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus"><span class="type">GnomeVFSXferProgressStatus</span></a> provides one value signalling abortion that maps to <code class="literal">0</code>.
869
 
Therefore, returning <code class="literal">0</code> will always abort the Xfer. On abortion, if the <em class="parameter"><code>info</code></em>'s <code class="literal">vfs_status</code>
870
 
is <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK--CAPS"><span class="type">GNOME_VFS_OK</span></a>, the Xfer operation result will be set to <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-ERROR-INTERRUPTED--CAPS"><span class="type">GNOME_VFS_ERROR_INTERRUPTED</span></a>,
871
 
otherwise the operation result will be set to <code class="literal">vfs_status</code> to distinguish completely
872
 
user-driven aborts from those involving a problem during the Xfer.
873
 
</div>
874
 
<p>
875
 
</p>
876
 
<div class="variablelist"><table border="0">
877
 
<col align="left" valign="top">
878
 
<tbody>
879
 
<tr>
880
 
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
881
 
<td> The <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a> associated with this transfer operation.
882
 
</td>
883
 
</tr>
884
 
<tr>
885
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
886
 
<td> The user data passed to <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()"><code class="function">gnome_vfs_xfer_uri()</code></a>, <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()"><code class="function">gnome_vfs_xfer_uri_list()</code></a>,
887
 
               <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-delete-list" title="gnome_vfs_xfer_delete_list ()"><code class="function">gnome_vfs_xfer_delete_list()</code></a> or <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a>.
888
 
</td>
889
 
</tr>
890
 
<tr>
891
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
892
 
<td> Whether the process should be aborted, or whether a special action should be taken.
893
 
</td>
894
 
</tr>
895
 
</tbody>
896
 
</table></div>
897
 
</div>
898
 
<hr>
899
 
<div class="refsect2" lang="en">
900
 
<a name="gnome-vfs-xfer-uri-list"></a><h3>gnome_vfs_xfer_uri_list ()</h3>
901
 
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      gnome_vfs_xfer_uri_list             (const GList *source_uri_list,
902
 
                                                         const GList *target_uri_list,
903
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions">GnomeVFSXferOptions</a> xfer_options,
904
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode">GnomeVFSXferErrorMode</a> error_mode,
905
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode">GnomeVFSXferOverwriteMode</a> overwrite_mode,
906
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()">GnomeVFSXferProgressCallback</a> progress_callback,
907
 
                                                         gpointer data);</pre>
908
 
<p>
909
 
This function will transfer multiple files to multiple targets, given
910
 
source URIs and destination URIs. If you want to do asynchronous
911
 
file transfers, you have to use <a class="link" href="gnome-vfs-20-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a> instead.</p>
912
 
<p>
913
 
</p>
914
 
<div class="variablelist"><table border="0">
915
 
<col align="left" valign="top">
916
 
<tbody>
917
 
<tr>
918
 
<td><p><span class="term"><em class="parameter"><code>source_uri_list</code></em> :</span></p></td>
919
 
<td> A <span class="type">GList</span> of source <span class="type">GnomeVFSURIs</span>.
920
 
</td>
921
 
</tr>
922
 
<tr>
923
 
<td><p><span class="term"><em class="parameter"><code>target_uri_list</code></em> :</span></p></td>
924
 
<td> A <span class="type">GList</span> of target <span class="type">GnomeVFSURIs</span>, each corresponding to one URI in
925
 
<em class="parameter"><code>source_uri_list</code></em>.
926
 
</td>
927
 
</tr>
928
 
<tr>
929
 
<td><p><span class="term"><em class="parameter"><code>xfer_options</code></em> :</span></p></td>
930
 
<td> <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> defining the desired operation and parameters.
931
 
</td>
932
 
</tr>
933
 
<tr>
934
 
<td><p><span class="term"><em class="parameter"><code>error_mode</code></em> :</span></p></td>
935
 
<td> A <span class="type">GnomeVFSErrorMode</span> specifying how to proceed if a VFS error occurs.
936
 
</td>
937
 
</tr>
938
 
<tr>
939
 
<td><p><span class="term"><em class="parameter"><code>overwrite_mode</code></em> :</span></p></td>
940
 
<td> A <span class="type">GnomeVFSOverwriteMode</span> specifying how to proceed if a file is being overwritten.
941
 
</td>
942
 
</tr>
943
 
<tr>
944
 
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
945
 
<td> This <span class="type">GnomeVFSProgressCallback</span> is used to inform the user about
946
 
the progress of a transfer, and to request further input from him if a problem occurs.
947
 
</td>
948
 
</tr>
949
 
<tr>
950
 
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
951
 
<td> Data to be passed back in callbacks from the xfer engine.
952
 
</td>
953
 
</tr>
954
 
<tr>
955
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
956
 
<td> If all goes well it returns <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GNOME-VFS-OK--CAPS"><code class="literal">GNOME_VFS_OK</code></a>.  Check <a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="type">GnomeVFSResult</span></a> for
957
 
other values.
958
 
</td>
959
 
</tr>
960
 
</tbody>
961
 
</table></div>
962
 
</div>
963
 
<hr>
964
 
<div class="refsect2" lang="en">
965
 
<a name="gnome-vfs-xfer-uri"></a><h3>gnome_vfs_xfer_uri ()</h3>
966
 
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      gnome_vfs_xfer_uri                  (const <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *source_uri,
967
 
                                                         const <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *target_uri,
968
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions">GnomeVFSXferOptions</a> xfer_options,
969
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode">GnomeVFSXferErrorMode</a> error_mode,
970
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode">GnomeVFSXferOverwriteMode</a> overwrite_mode,
971
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()">GnomeVFSXferProgressCallback</a> progress_callback,
972
 
                                                         gpointer data);</pre>
973
 
<p>
974
 
This function works exactly like <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()"><code class="function">gnome_vfs_xfer_uri_list()</code></a>, and is a
975
 
convenience wrapper for only acting on one source/target URI pair.</p>
976
 
<p>
977
 
</p>
978
 
<div class="variablelist"><table border="0">
979
 
<col align="left" valign="top">
980
 
<tbody>
981
 
<tr>
982
 
<td><p><span class="term"><em class="parameter"><code>source_uri</code></em> :</span></p></td>
983
 
<td> A source <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>.
984
 
</td>
985
 
</tr>
986
 
<tr>
987
 
<td><p><span class="term"><em class="parameter"><code>target_uri</code></em> :</span></p></td>
988
 
<td> A target <a class="link" href="gnome-vfs-20-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>.
989
 
</td>
990
 
</tr>
991
 
<tr>
992
 
<td><p><span class="term"><em class="parameter"><code>xfer_options</code></em> :</span></p></td>
993
 
<td> <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> defining the desired operation and parameters.
994
 
</td>
995
 
</tr>
996
 
<tr>
997
 
<td><p><span class="term"><em class="parameter"><code>error_mode</code></em> :</span></p></td>
998
 
<td> A <span class="type">GnomeVFSErrorMode</span> specifying how to proceed if a VFS error occurs.
999
 
</td>
1000
 
</tr>
1001
 
<tr>
1002
 
<td><p><span class="term"><em class="parameter"><code>overwrite_mode</code></em> :</span></p></td>
1003
 
<td> A <span class="type">GnomeVFSOverwriteMode</span> specifying how to proceed if a file is being overwritten.
1004
 
</td>
1005
 
</tr>
1006
 
<tr>
1007
 
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
1008
 
<td> This <span class="type">GnomeVFSProgressCallback</span> is used to inform the user about
1009
 
the progress of a transfer, and to request further input from him if a problem occurs.
1010
 
</td>
1011
 
</tr>
1012
 
<tr>
1013
 
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1014
 
<td> Data to be passed back in callbacks from the xfer engine.
1015
 
</td>
1016
 
</tr>
1017
 
<tr>
1018
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1019
 
<td> an integer representing the result of the operation.
1020
 
</td>
1021
 
</tr>
1022
 
</tbody>
1023
 
</table></div>
1024
 
</div>
1025
 
<hr>
1026
 
<div class="refsect2" lang="en">
1027
 
<a name="gnome-vfs-xfer-delete-list"></a><h3>gnome_vfs_xfer_delete_list ()</h3>
1028
 
<pre class="programlisting"><a class="link" href="gnome-vfs-20-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult">GnomeVFSResult</a>      gnome_vfs_xfer_delete_list          (const GList *source_uri_list,
1029
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode">GnomeVFSXferErrorMode</a> error_mode,
1030
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions">GnomeVFSXferOptions</a> xfer_options,
1031
 
                                                         <a class="link" href="gnome-vfs-20-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()">GnomeVFSXferProgressCallback</a> progress_callback,
1032
 
                                                         gpointer data);</pre>
1033
 
<p>
1034
 
Unlinks items in the <em class="parameter"><code>source_uri_list</code></em> from their filesystems.</p>
1035
 
<p>
1036
 
</p>
1037
 
<div class="variablelist"><table border="0">
1038
 
<col align="left" valign="top">
1039
 
<tbody>
1040
 
<tr>
1041
 
<td><p><span class="term"><em class="parameter"><code>source_uri_list</code></em> :</span></p></td>
1042
 
<td> This is a list containing uris.
1043
 
</td>
1044
 
</tr>
1045
 
<tr>
1046
 
<td><p><span class="term"><em class="parameter"><code>error_mode</code></em> :</span></p></td>
1047
 
<td> Decide how you want to deal with interruptions.
1048
 
</td>
1049
 
</tr>
1050
 
<tr>
1051
 
<td><p><span class="term"><em class="parameter"><code>xfer_options</code></em> :</span></p></td>
1052
 
<td> Set whatever transfer options you need.
1053
 
</td>
1054
 
</tr>
1055
 
<tr>
1056
 
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
1057
 
<td> Callback to check on progress of transfer.
1058
 
</td>
1059
 
</tr>
1060
 
<tr>
1061
 
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1062
 
<td> Data to be passed back in callbacks from the xfer engine.
1063
 
</td>
1064
 
</tr>
1065
 
<tr>
1066
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1067
 
<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 successful, or the appropriate error code otherwise.
1068
 
</td>
1069
 
</tr>
1070
 
</tbody>
1071
 
</table></div>
1072
 
</div>
1073
 
</div>
1074
 
</div>
1075
 
<div class="footer">
1076
 
<hr>
1077
 
          Generated by GTK-Doc V1.11</div>
1078
 
</body>
1079
 
</html>