TransferOptions Class

Defines options for file transfers.

You can have WinSCP generate a code template for TransferOptions for you.

Advertisements:

Syntax

Namespace: WinSCP

C#
public sealed class TransferOptions
VB.NET
Public NotInheritable Class TransferOptions

Constructors

Name Description
TransferOptions() Default constructor.

Properties

Name Description
string FileMask File mask.
FilePermissions FilePermissions Permissions to applied to a remote file (used for uploads only). Use default null to keep default permissions.
OverwriteMode OverwriteMode Behavior when overwriting existing files.
Possible values are:
OverwriteMode.Overwrite (default) to overwrite the existing files.
OverwriteMode.Resume to assume that the existing and smaller file is a remnant of an interrupted transfer and resumes the transfer. SFTP and FTP protocols only.
OverwriteMode.Append to append the source file to the end of existing target file. SFTP protocol only.
bool PreserveTimestamp Preserve timestamp (set last write time of destination file to that of source file). Defaults to true.
When used with Session.SynchronizeDirectories, timestamp is always preserved, disregarding property value, unless criteria parameter is SynchronizationCriteria.None or SynchronizationCriteria.Size.
TransferResumeSupport ResumeSupport Configures automatic resume/transfer to temporary filename.
int SpeedLimit Limit transfer speed (in KB/s).
TransferMode TransferMode Transfer mode. Possible values are TransferMode.Binary (default), TransferMode.Ascii and TransferMode.Automatic (based on file extension).

Remarks

Examples

Real-Life Example

 
  library_transferoptions.txt · Last modified: by martin
 

Search Documentation

This page

Donate

About donations

$9   $19   $49   $99

About donations

Recommend

Associations

Site design by Black Gate