libgnomevfs2-dev 1:2.24.4-1ubuntu6 / usr / share / doc / libgnomevfs2-common / html / gnome-vfs-2.0-gnome-vfs-xfer.html

This file is indexed.

/usr/share/doc/libgnomevfs2-common/html/gnome-vfs-2.0-gnome-vfs-xfer.html is in libgnomevfs2-dev 1:2.24.4-1ubuntu6.

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
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>File Transfers</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
<link rel="up" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
<link rel="prev" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
<link rel="next" href="gnome-vfs-2.0-gnome-vfs-monitor.html" title="Monitoring">
<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-file-and-dirs-ops.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<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>
<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-monitor.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-xfer.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gnome-vfs-2.0-gnome-vfs-xfer.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gnome-vfs-2.0-gnome-vfs-xfer"></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-xfer.top_of_page"></a>File Transfers</span></h2>
<p>File Transfers — Conveniently copy/move/delete files en masse</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gnome-vfs-2.0-gnome-vfs-xfer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions">GnomeVFSXferOptions</a>;
enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus">GnomeVFSXferProgressStatus</a>;
enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode">GnomeVFSXferOverwriteMode</a>;
enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOverwriteAction" title="enum GnomeVFSXferOverwriteAction">GnomeVFSXferOverwriteAction</a>;
enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode">GnomeVFSXferErrorMode</a>;
enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorAction" title="enum GnomeVFSXferErrorAction">GnomeVFSXferErrorAction</a>;
enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferPhase" title="enum GnomeVFSXferPhase">GnomeVFSXferPhase</a>;
                    <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo">GnomeVFSXferProgressInfo</a>;
<span class="returnvalue">gint</span>                (<a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()">*GnomeVFSXferProgressCallback</a>)     (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a> *info</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</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-xfer.html#gnome-vfs-xfer-uri-list" title="gnome_vfs_xfer_uri_list ()">gnome_vfs_xfer_uri_list</a>             (<em class="parameter"><code>const <span class="type">GList</span> *source_uri_list</code></em>,
                                                         <em class="parameter"><code>const <span class="type">GList</span> *target_uri_list</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> xfer_options</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode"><span class="type">GnomeVFSXferErrorMode</span></a> error_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode"><span class="type">GnomeVFSXferOverwriteMode</span></a> overwrite_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> progress_callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</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-xfer.html#gnome-vfs-xfer-uri" title="gnome_vfs_xfer_uri ()">gnome_vfs_xfer_uri</a>                  (<em class="parameter"><code>const <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>const <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><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> xfer_options</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode"><span class="type">GnomeVFSXferErrorMode</span></a> error_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode"><span class="type">GnomeVFSXferOverwriteMode</span></a> overwrite_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> progress_callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</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-xfer.html#gnome-vfs-xfer-delete-list" title="gnome_vfs_xfer_delete_list ()">gnome_vfs_xfer_delete_list</a>          (<em class="parameter"><code>const <span class="type">GList</span> *source_uri_list</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode"><span class="type">GnomeVFSXferErrorMode</span></a> error_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> xfer_options</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> progress_callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-xfer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-xfer.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomeVFSXferOptions"></a><h3>enum GnomeVFSXferOptions</h3>
<pre class="programlisting">typedef enum {
	GNOME_VFS_XFER_DEFAULT = 0,
	GNOME_VFS_XFER_UNUSED_1 = 1 &lt;&lt; 0,
	GNOME_VFS_XFER_FOLLOW_LINKS = 1 &lt;&lt; 1,
	GNOME_VFS_XFER_UNUSED_2 = 1 &lt;&lt; 2,
	GNOME_VFS_XFER_RECURSIVE = 1 &lt;&lt; 3,
	GNOME_VFS_XFER_SAMEFS = 1 &lt;&lt; 4,
	GNOME_VFS_XFER_DELETE_ITEMS = 1 &lt;&lt; 5,
	GNOME_VFS_XFER_EMPTY_DIRECTORIES = 1 &lt;&lt; 6,
	GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY = 1 &lt;&lt; 7,
	GNOME_VFS_XFER_REMOVESOURCE = 1 &lt;&lt; 8,
	GNOME_VFS_XFER_USE_UNIQUE_NAMES = 1 &lt;&lt; 9,
	GNOME_VFS_XFER_LINK_ITEMS = 1 &lt;&lt; 10,
	GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE = 1 &lt;&lt; 11,
	GNOME_VFS_XFER_TARGET_DEFAULT_PERMS = 1 &lt;&lt; 12
} GnomeVFSXferOptions;
</pre>
<p>
These options control the way <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>, <a class="link" href="gnome-vfs-2.0-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>,
<a class="link" href="gnome-vfs-2.0-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-2.0-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a> work.
</p>
<p>
At a first glance the <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> semantics are not very intuitive.
</p>
<p>
There are two types of <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a>: Those that define an operation,
i.e. describe what to do, and those that influence how to execute the
operation.
</p>
<p>
</p>
<div class="table">
<a name="idp65119616"></a><p class="title"><b>Table 1. Operation Selection</b></p>
<div class="table-contents"><table summary="Operation Selection" border="0">
<colgroup>
<col align="left">
<col align="left">
<col align="left">
</colgroup>
<thead><tr>
<th align="left">
<a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> entry</th>
<th align="left">Operation</th>
<th align="left">UNIX equivalent</th>
<th align="left">Comments</th>
</tr></thead>
<tbody>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-DEFAULT:CAPS"><span class="type">GNOME_VFS_XFER_DEFAULT</span></a></td>
<td align="left">Copy</td>
<td align="left"><code class="literal">cp</code></td>
</tr>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-REMOVESOURCE:CAPS"><span class="type">GNOME_VFS_XFER_REMOVESOURCE</span></a></td>
<td align="left">Move</td>
<td align="left"><code class="literal">mv</code></td>
</tr>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-LINK-ITEMS:CAPS"><span class="type">GNOME_VFS_XFER_LINK_ITEMS</span></a></td>
<td align="left">Link</td>
<td align="left"><code class="literal">ln -s</code></td>
</tr>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-NEW-UNIQUE-DIRECTORY:CAPS"><span class="type">GNOME_VFS_XFER_NEW_UNIQUE_DIRECTORY</span></a></td>
<td align="left">Make Unique Directory</td>
<td align="left"><code class="literal">mkdir</code></td>
<td align="left">implies <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-USE-UNIQUE-NAMES:CAPS"><span class="type">GNOME_VFS_XFER_USE_UNIQUE_NAMES</span></a>
</td>
</tr>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-DELETE-ITEMS:CAPS"><span class="type">GNOME_VFS_XFER_DELETE_ITEMS</span></a></td>
<td align="left">Remove</td>
<td align="left"><code class="literal">rm -r</code></td>
</tr>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-EMPTY-DIRECTORIES:CAPS"><span class="type">GNOME_VFS_XFER_EMPTY_DIRECTORIES</span></a></td>
<td align="left">Remove Directory Contents</td>
<td align="left">foreach file: <code class="literal">( cd file &amp;&amp; rm -rf * )</code>
</td>
<td align="left">used to empty trash</td>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
   Because <a class="link" href="gnome-vfs-2.0-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.
   Thus, not explicitly specifying any operation at all, or just specifying
   <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-DEFAULT:CAPS"><span class="type">GNOME_VFS_XFER_DEFAULT</span></a> will both execute a copy.
 </p>
<p>
   If an operation other than <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-DEFAULT:CAPS"><span class="type">GNOME_VFS_XFER_DEFAULT</span></a> is
   specified, it will override the copy operation, but you may only specify
   <span class="emphasis"><em>one</em></span> of the other operations at a time.
 </p>
<p>
   This unintuitive operation selection unfortunately poses an API weakness
   and an obstacle in client development, and will be modified in a later
   revision of this API.
 </p>
</div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GNOME-VFS-XFER-DEFAULT:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_DEFAULT</code></span></p></td>
<td>Default behavior, which is to do a straight one to one copy.
</td>
</tr>
<tr>
<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>
<td>Unused.
</td>
</tr>
<tr>
<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>
<td>Follow symbolic links when copying or moving, i.e.
				 the target of symbolic links are copied
				 rather than the symbolic links themselves.
				 Note that this just refers to top-level items.
				 If you also want to follow symbolic links inside
				 directories you operate on, you also have to specify
				 <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-FOLLOW-LINKS-RECURSIVE:CAPS"><span class="type">GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE</span></a>.
</td>
</tr>
<tr>
<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>
<td>Unused.
</td>
</tr>
<tr>
<td><p><a name="GNOME-VFS-XFER-RECURSIVE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_RECURSIVE</code></span></p></td>
<td>Recursively copy source directories to the target. 
			      Equivalent to the cp -r option in GNU cp.
</td>
</tr>
<tr>
<td><p><a name="GNOME-VFS-XFER-SAMEFS:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_SAMEFS</code></span></p></td>
<td>When copying recursively, this only picks up items on the same file
			   system the same filesystem as their parent directory.
</td>
</tr>
<tr>
<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>
<td>This is equivalent to an <code class="function">rmdir()</code> for source directories,
				 and an <code class="function">unlink()</code> operation for all source files.
				 Requires <code class="literal">NULL</code> target URIs.
</td>
</tr>
<tr>
<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>
<td>Remove the whole contents of the passed-in source
				      directories. Requires <code class="literal">NULL</code> target URIs.
</td>
</tr>
<tr>
<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>
<td>This will create a directory if it doesn't exist
					 in the destination area (i.e. <code class="function">mkdir()</code>).
</td>
</tr>
<tr>
<td><p><a name="GNOME-VFS-XFER-REMOVESOURCE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_XFER_REMOVESOURCE</code></span></p></td>
<td>This makes a copy operation equivalent to a mv, i.e. the
				 files will be moved rather than copied. If applicable, this
				 will use <code class="function">rename()</code>, otherwise (i.e. across file systems),
				 it will fall back to a copy operation followed by a source
				 file deletion.
</td>
</tr>
<tr>
<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>
<td>When this option is present, and a name collisions on
				     the target occurs, the progress callback will be asked
				     for a new name, until the newly provided name doesn't
				     conflict or the request callback transfer cancellation.
</td>
</tr>
<tr>
<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>
<td>Executes a symlink operation for each of the source/target URI pairs,
			       i.e. similar to GNU ln -s source target.
			       NB: The symlink target has to be specified as source URI,
			       	   and the symlink itself as target URI.
</td>
</tr>
<tr>
<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>
<td>This means that when doing a copy operation, symbolic
					   links in subdirectories are dereferenced. This is
					   typically used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-FOLLOW-LINKS-RECURSIVE:CAPS"><span class="type">GNOME_VFS_XFER_FOLLOW_LINKS_RECURSIVE</span></a>.
</td>
</tr>
<tr>
<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>
<td>This means that the target file will not have the same
					 permissions as the source file, but will instead have
					 the default permissions of the destination location.
					 This is useful when copying from read-only locations (CDs).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSXferProgressStatus"></a><h3>enum GnomeVFSXferProgressStatus</h3>
<pre class="programlisting">typedef enum {
	GNOME_VFS_XFER_PROGRESS_STATUS_OK = 0,
	GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR = 1,
	GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE = 2,
	GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE = 3
} GnomeVFSXferProgressStatus;
</pre>
<p>
The difference between <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-OVERWRITE:CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE</span></a> and
<a class="link" href="gnome-vfs-2.0-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
at different occassions, and that the return value will be interpreted
differently. For details, see <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<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>
<td>The file transfer is progressing normally.
</td>
</tr>
<tr>
<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>
<td>A VFS error was detected.
</td>
</tr>
<tr>
<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>
<td>The current target file specified by the
					      <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a>'s <code class="literal">target_name</code>
					      field already exists.
</td>
</tr>
<tr>
<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>
<td>The current target file specified by the
					      <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a>'s <code class="literal">target_name</code>
					      field already exists, and the progress
					      callback is asked to supply a new unique name.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSXferOverwriteMode"></a><h3>enum GnomeVFSXferOverwriteMode</h3>
<pre class="programlisting">typedef enum {
	GNOME_VFS_XFER_OVERWRITE_MODE_ABORT = 0,
	GNOME_VFS_XFER_OVERWRITE_MODE_QUERY = 1,
	GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE = 2,
	GNOME_VFS_XFER_OVERWRITE_MODE_SKIP = 3
} GnomeVFSXferOverwriteMode;
</pre>
<p>
This is passed to <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>, <a class="link" href="gnome-vfs-2.0-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>,
<a class="link" href="gnome-vfs-2.0-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-2.0-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
what action should be taken when a target file already exists.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<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>
<td>Abort the transfer when a target file already exists,
					 returning the error <span class="type">GNOME_VFS_ERROR_FILEEXISTS</span>.
</td>
</tr>
<tr>
<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>
<td>Query the progress callback with the
					 <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a>'s status field
					 set to <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-VFSERROR:CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR</span></a> when
					 a target file already exists.
</td>
</tr>
<tr>
<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>
<td>Replace existing target files silently.
					   Don't worry be happy.
</td>
</tr>
<tr>
<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>
<td>Skip source files when its target already exists.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSXferOverwriteAction"></a><h3>enum GnomeVFSXferOverwriteAction</h3>
<pre class="programlisting">typedef enum {
	GNOME_VFS_XFER_OVERWRITE_ACTION_ABORT = 0,
	GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE = 1,
	GNOME_VFS_XFER_OVERWRITE_ACTION_REPLACE_ALL = 2,
	GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP = 3,
	GNOME_VFS_XFER_OVERWRITE_ACTION_SKIP_ALL = 4
} GnomeVFSXferOverwriteAction;
</pre>
<p>
This defines the actions to perform before a file is being overwritten
(i.e., these are the answers that can be given to a replace query).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<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>
<td>abort the transfer
</td>
</tr>
<tr>
<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>
<td>replace the existing file
</td>
</tr>
<tr>
<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>
<td>replace the existing file, and all future files
without prompting the callback.
</td>
</tr>
<tr>
<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>
<td>don't copy over the existing file
</td>
</tr>
<tr>
<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>
<td>don't copy over the existing file, and all future
files without prompting the callback.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSXferErrorMode"></a><h3>enum GnomeVFSXferErrorMode</h3>
<pre class="programlisting">typedef enum {
	GNOME_VFS_XFER_ERROR_MODE_ABORT = 0,
	GNOME_VFS_XFER_ERROR_MODE_QUERY = 1
} GnomeVFSXferErrorMode;
</pre>
<p>
This is passed to <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>, <a class="link" href="gnome-vfs-2.0-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>,
<a class="link" href="gnome-vfs-2.0-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-2.0-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
what action should be taken when transfer errors are detected.
</p>
<p>
The progress callback is either a <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> for synchronous
Xfer operations, or a <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSAsyncXferProgressCallback" title="GnomeVFSAsyncXferProgressCallback ()"><span class="type">GnomeVFSAsyncXferProgressCallback</span></a> for asynchronous operations.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<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>
<td>abort the transfer when an error occurs
</td>
</tr>
<tr>
<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>
<td>query the progress callback with the
				     <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a>'s status field
				     set to <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-VFSERROR:CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSXferErrorAction"></a><h3>enum GnomeVFSXferErrorAction</h3>
<pre class="programlisting">typedef enum {
	GNOME_VFS_XFER_ERROR_ACTION_ABORT = 0,
	GNOME_VFS_XFER_ERROR_ACTION_RETRY = 1,
	GNOME_VFS_XFER_ERROR_ACTION_SKIP = 2
} GnomeVFSXferErrorAction;
</pre>
<p>
This defines the possible actions to be performed after a VFS error has occurred, i.e.
when a GnomeVFS file operation issued during the transfer returned a result that is not
equal to <a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><span class="type">GNOME_VFS_OK</span></a>.
</p>
<p>
It is returned by the progress callback which is either a <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a>
for synchronous Xfer operations, or a <a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSAsyncXferProgressCallback" title="GnomeVFSAsyncXferProgressCallback ()"><span class="type">GnomeVFSAsyncXferProgressCallback</span></a> for asynchronous
operations.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<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>
<td>interrupt Xfer and return <a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GNOME-VFS-ERROR-INTERRUPTED:CAPS"><code class="literal">GNOME_VFS_ERROR_INTERRUPTED</code></a>.
</td>
</tr>
<tr>
<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>
<td>retry the failed operation.
</td>
</tr>
<tr>
<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>
<td>skip the failed operation, and continue Xfer normally.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSXferPhase"></a><h3>enum GnomeVFSXferPhase</h3>
<pre class="programlisting">typedef enum {
	GNOME_VFS_XFER_PHASE_INITIAL,
	GNOME_VFS_XFER_CHECKING_DESTINATION,
	GNOME_VFS_XFER_PHASE_COLLECTING,
	GNOME_VFS_XFER_PHASE_READYTOGO,
	GNOME_VFS_XFER_PHASE_OPENSOURCE,
	GNOME_VFS_XFER_PHASE_OPENTARGET,
	GNOME_VFS_XFER_PHASE_COPYING,
	GNOME_VFS_XFER_PHASE_MOVING,
	GNOME_VFS_XFER_PHASE_READSOURCE,
	GNOME_VFS_XFER_PHASE_WRITETARGET,
	GNOME_VFS_XFER_PHASE_CLOSESOURCE,
	GNOME_VFS_XFER_PHASE_CLOSETARGET,
	GNOME_VFS_XFER_PHASE_DELETESOURCE,
	GNOME_VFS_XFER_PHASE_SETATTRIBUTES,
	GNOME_VFS_XFER_PHASE_FILECOMPLETED,
	GNOME_VFS_XFER_PHASE_CLEANUP,
	GNOME_VFS_XFER_PHASE_COMPLETED,
	GNOME_VFS_XFER_NUM_PHASES
} GnomeVFSXferPhase;
</pre>
<p>
Specifies the current phase of an Xfer operation that was
initiated using <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>, <a class="link" href="gnome-vfs-2.0-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>,
<a class="link" href="gnome-vfs-2.0-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-2.0-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a>.
</p>
<p>
Whenever the Xfer phase is in a phase that is highlighted with a
(*), the <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> respectively
<a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSAsyncXferProgressCallback" title="GnomeVFSAsyncXferProgressCallback ()"><span class="type">GnomeVFSAsyncXferProgressCallback</span></a> is never invoked with a
<a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus"><span class="type">GnomeVFSXferProgressStatus</span></a> other than <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-OK:CAPS"><code class="literal">GNOME_VFS_XFER_PROGRESS_STATUS_OK</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<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>
<td>initial phase.
</td>
</tr>
<tr>
<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>
<td>destination is checked for being able to handle copy/move.
</td>
</tr>
<tr>
<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>
<td>source file list is collected.
</td>
</tr>
<tr>
<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>
<td>source file list has been collected (*).
</td>
</tr>
<tr>
<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>
<td>source file is opened for reading.
</td>
</tr>
<tr>
<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>
<td>target file, directory or symlink is created, or opened for copying.
</td>
</tr>
<tr>
<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>
<td>data is copied from source file to target file (*).
</td>
</tr>
<tr>
<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>
<td>source file is moved to target (M).
</td>
</tr>
<tr>
<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>
<td>data is read from a source file, when copying.
</td>
</tr>
<tr>
<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>
<td>data is written to a target file, when copying.
</td>
</tr>
<tr>
<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>
<td>source file is closed, when copying
</td>
</tr>
<tr>
<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>
<td>target file is closed, when copying.
</td>
</tr>
<tr>
<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>
<td>source file is deleted.
</td>
</tr>
<tr>
<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>
<td>target file attributes are set.
</td>
</tr>
<tr>
<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>
<td>one file was completed, ready for next file.
</td>
</tr>
<tr>
<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>
<td>cleanup after moving (i.e. source files deletion).
</td>
</tr>
<tr>
<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>
<td>operation finished (*).
</td>
</tr>
<tr>
<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>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSXferProgressInfo"></a><h3>GnomeVFSXferProgressInfo</h3>
<pre class="programlisting">typedef struct {
	GnomeVFSXferProgressStatus status;

	GnomeVFSResult vfs_status;

	GnomeVFSXferPhase phase;

	/* Source URI. FIXME bugzilla.eazel.com 1206: change name? */
	gchar *source_name;

	/* Destination URI. FIXME bugzilla.eazel.com 1206: change name? */
	gchar *target_name;

	gulong file_index;

	gulong files_total;

	GnomeVFSFileSize bytes_total;

	GnomeVFSFileSize file_size;

	GnomeVFSFileSize bytes_copied;

	GnomeVFSFileSize total_bytes_copied;

	gchar *duplicate_name;

	int duplicate_count;

	gboolean top_level_item;

	/* Reserved for future expansions to GnomeVFSXferProgressInfo
	 * without having to break ABI compatibility */
} GnomeVFSXferProgressInfo;
</pre>
<p>
Provides progress information for the transfer operation.
This is especially useful for interactive programs.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus"><span class="type">GnomeVFSXferProgressStatus</span></a> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.status"></a>status</code></em>;</span></p></td>
<td>A <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus"><span class="type">GnomeVFSXferProgressStatus</span></a> describing the current status.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="type">GnomeVFSResult</span></a> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.vfs-status"></a>vfs_status</code></em>;</span></p></td>
<td>A <a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="type">GnomeVFSResult</span></a> describing the current VFS status.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferPhase" title="enum GnomeVFSXferPhase"><span class="type">GnomeVFSXferPhase</span></a> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.phase"></a>phase</code></em>;</span></p></td>
<td>A <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferPhase" title="enum GnomeVFSXferPhase"><span class="type">GnomeVFSXferPhase</span></a> describing the current transfer phase.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GnomeVFSXferProgressInfo.source-name"></a>source_name</code></em>;</span></p></td>
<td>The Currently processed source URI.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GnomeVFSXferProgressInfo.target-name"></a>target_name</code></em>;</span></p></td>
<td>The Currently processed target URI.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gulong</span> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.file-index"></a>file_index</code></em>;</span></p></td>
<td>The index of the currently processed file.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gulong</span> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.files-total"></a>files_total</code></em>;</span></p></td>
<td>The total number of processed files.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.bytes-total"></a>bytes_total</code></em>;</span></p></td>
<td>The total size of all files to transfer in bytes.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.file-size"></a>file_size</code></em>;</span></p></td>
<td>The size of the currently processed file in bytes.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.bytes-copied"></a>bytes_copied</code></em>;</span></p></td>
<td>The number of bytes that has been transferred
from the current file.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.total-bytes-copied"></a>total_bytes_copied</code></em>;</span></p></td>
<td>The total number of bytes that has been transferred.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GnomeVFSXferProgressInfo.duplicate-name"></a>duplicate_name</code></em>;</span></p></td>
<td>The name specifying a duplicate filename.
It acts as pointer to both input and output
data. It is only valid input data if <em class="parameter"><code>status</code></em> is
GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE,
in which case <em class="parameter"><code>duplicate_count</code></em> and <em class="parameter"><code>duplicate_name</code></em>
should be used by the <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a>
to pick a new unique target name.
If the callback wants to retry with a new unique name
it is supposed to free the old <em class="parameter"><code>duplicate_name</code></em>
set it to a valid string describing the new file name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.duplicate-count"></a>duplicate_count</code></em>;</span></p></td>
<td>The number of conflicts that ocurred when the
current <em class="parameter"><code>duplicate_name</code></em> was set.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">gboolean</span> <em class="structfield"><code><a name="GnomeVFSXferProgressInfo.top-level-item"></a>top_level_item</code></em>;</span></p></td>
<td>This flag signals that the currently
processed file is a top level item.
If it is <code class="literal">TRUE</code>, one of the files passed to
<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>, <a class="link" href="gnome-vfs-2.0-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>,
<a class="link" href="gnome-vfs-2.0-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-2.0-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a>
is currently processed.
If it is <code class="literal">FALSE</code>, a file or directory that is inside
a directory specified by the passed in source list
is currently processed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSXferProgressCallback"></a><h3>GnomeVFSXferProgressCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                (*GnomeVFSXferProgressCallback)     (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a> *info</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
This is the prototype for functions called during a transfer operation to
report progress.
</p>
<p>
The interpretation of the return value of the callback depends on the
GnomeVFSXferProgressStaus <code class="literal">status</code> field of GnomeVFSXferProgressInfo,
some status/return value combinations require modification of
particular <em class="parameter"><code>info</code></em> fields.
</p>
<p>
</p>
<div class="table">
<a name="idp65434016"></a><p class="title"><b>Table 2. Status/Return Value Overview</b></p>
<div class="table-contents"><table summary="Status/Return Value Overview" border="0">
<colgroup>
<col align="left">
<col align="left">
<col align="left">
</colgroup>
<thead><tr>
<th align="left">
<a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressStatus" title="enum GnomeVFSXferProgressStatus"><span class="type">GnomeVFSXferProgressStatus</span></a> status</th>
<th align="left">Status</th>
<th align="left">Only If</th>
<th align="left">Return Value Interpretation</th>
</tr></thead>
<tbody>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-OK:CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_OK</span></a></td>
<td align="left">OK</td>
<td align="left"> </td>
<td align="left">
<code class="literal">0</code>: abort, otherwise continue</td>
</tr>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-VFSERROR:CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_VFSERROR</span></a></td>
<td align="left">VFS Error Ocurred</td>
<td align="left">
<a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode"><span class="type">GnomeVFSXferErrorMode</span></a> is <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-ERROR-MODE-QUERY:CAPS"><span class="type">GNOME_VFS_XFER_ERROR_MODE_QUERY</span></a>
</td>
<td align="left">GnomeVFSXferErrorAction</td>
</tr>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-OVERWRITE:CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_OVERWRITE</span></a></td>
<td align="left">Conflict Ocurred, Overwrite?</td>
<td align="left">
           <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode"><span class="type">GnomeVFSXferOverwriteMode</span></a> is <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-OVERWRITE-MODE-QUERY:CAPS"><span class="type">GNOME_VFS_XFER_OVERWRITE_MODE_QUERY</span></a>,
           <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> does not have <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-USE-UNIQUE-NAMES:CAPS"><span class="type">GNOME_VFS_XFER_USE_UNIQUE_NAMES</span></a>.
    </td>
<td align="left">GnomeVFSXferOverwriteAction</td>
</tr>
<tr>
<td align="left"><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-PROGRESS-STATUS-DUPLICATE:CAPS"><span class="type">GNOME_VFS_XFER_PROGRESS_STATUS_DUPLICATE</span></a></td>
<td align="left">Conflict Ocurred, New Target Name?</td>
<td align="left">
<a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> does have <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GNOME-VFS-XFER-USE-UNIQUE-NAMES:CAPS"><span class="type">GNOME_VFS_XFER_USE_UNIQUE_NAMES</span></a>.</td>
<td align="left">
<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>
</tr>
</tbody>
</table></div>
</div>
<p><br class="table-break">
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
Each <a class="link" href="gnome-vfs-2.0-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>.
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>
is <a class="link" href="gnome-vfs-2.0-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-2.0-gnome-vfs-result.html#GNOME-VFS-ERROR-INTERRUPTED:CAPS"><span class="type">GNOME_VFS_ERROR_INTERRUPTED</span></a>,
otherwise the operation result will be set to <code class="literal">vfs_status</code> to distinguish completely
user-driven aborts from those involving a problem during the Xfer.
</div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>The <a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressInfo" title="GnomeVFSXferProgressInfo"><span class="type">GnomeVFSXferProgressInfo</span></a> associated with this transfer operation.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>The user data passed to <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>, <a class="link" href="gnome-vfs-2.0-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>,
<a class="link" href="gnome-vfs-2.0-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-2.0-gnome-vfs-async-ops.html#gnome-vfs-async-xfer" title="gnome_vfs_async_xfer ()"><code class="function">gnome_vfs_async_xfer()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether the process should be aborted, or whether a special action should be taken.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-xfer-uri-list"></a><h3>gnome_vfs_xfer_uri_list ()</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_xfer_uri_list             (<em class="parameter"><code>const <span class="type">GList</span> *source_uri_list</code></em>,
                                                         <em class="parameter"><code>const <span class="type">GList</span> *target_uri_list</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> xfer_options</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode"><span class="type">GnomeVFSXferErrorMode</span></a> error_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode"><span class="type">GnomeVFSXferOverwriteMode</span></a> overwrite_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> progress_callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
This function will transfer multiple files to multiple targets, given
source URIs and destination URIs. If you want to do asynchronous
file transfers, you have to use <a class="link" href="gnome-vfs-2.0-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>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source_uri_list</code></em> :</span></p></td>
<td>A <span class="type">GList</span> of source <a href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI"><span class="type">GnomeVFSURIs</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target_uri_list</code></em> :</span></p></td>
<td>A <span class="type">GList</span> of target <a href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI"><span class="type">GnomeVFSURIs</span></a>, each corresponding to one URI in
<em class="parameter"><code>source_uri_list</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xfer_options</code></em> :</span></p></td>
<td>
<a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> defining the desired operation and parameters.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error_mode</code></em> :</span></p></td>
<td>A <span class="type">GnomeVFSErrorMode</span> specifying how to proceed if a VFS error occurs.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>overwrite_mode</code></em> :</span></p></td>
<td>A <span class="type">GnomeVFSOverwriteMode</span> specifying how to proceed if a file is being overwritten.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
<td>This <span class="type">GnomeVFSProgressCallback</span> is used to inform the user about
the progress of a transfer, and to request further input from him if a problem occurs.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Data to be passed back in callbacks from the xfer engine.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>If all goes well it returns <a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a>.  Check <a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="type">GnomeVFSResult</span></a> for
other values.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-xfer-uri"></a><h3>gnome_vfs_xfer_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_xfer_uri                  (<em class="parameter"><code>const <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>const <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><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> xfer_options</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode"><span class="type">GnomeVFSXferErrorMode</span></a> error_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOverwriteMode" title="enum GnomeVFSXferOverwriteMode"><span class="type">GnomeVFSXferOverwriteMode</span></a> overwrite_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> progress_callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
This function works exactly like <a class="link" href="gnome-vfs-2.0-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
convenience wrapper for only acting on one source/target URI pair.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source_uri</code></em> :</span></p></td>
<td>A source <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target_uri</code></em> :</span></p></td>
<td>A target <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xfer_options</code></em> :</span></p></td>
<td>
<a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> defining the desired operation and parameters.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error_mode</code></em> :</span></p></td>
<td>A <span class="type">GnomeVFSErrorMode</span> specifying how to proceed if a VFS error occurs.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>overwrite_mode</code></em> :</span></p></td>
<td>A <span class="type">GnomeVFSOverwriteMode</span> specifying how to proceed if a file is being overwritten.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
<td>This <span class="type">GnomeVFSProgressCallback</span> is used to inform the user about
the progress of a transfer, and to request further input from him if a problem occurs.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Data to be passed back in callbacks from the xfer engine.</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-xfer-delete-list"></a><h3>gnome_vfs_xfer_delete_list ()</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_xfer_delete_list          (<em class="parameter"><code>const <span class="type">GList</span> *source_uri_list</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferErrorMode" title="enum GnomeVFSXferErrorMode"><span class="type">GnomeVFSXferErrorMode</span></a> error_mode</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferOptions" title="enum GnomeVFSXferOptions"><span class="type">GnomeVFSXferOptions</span></a> xfer_options</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-xfer.html#GnomeVFSXferProgressCallback" title="GnomeVFSXferProgressCallback ()"><span class="type">GnomeVFSXferProgressCallback</span></a> progress_callback</code></em>,
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
Unlinks items in the <em class="parameter"><code>source_uri_list</code></em> from their filesystems.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>source_uri_list</code></em> :</span></p></td>
<td>This is a list containing uris.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error_mode</code></em> :</span></p></td>
<td>Decide how you want to deal with interruptions.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xfer_options</code></em> :</span></p></td>
<td>Set whatever transfer options you need.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
<td>Callback to check on progress of transfer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Data to be passed back in callbacks from the xfer engine.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GNOME-VFS-OK:CAPS"><code class="literal">GNOME_VFS_OK</code></a> if successful, or the appropriate error code otherwise.</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.