This is an old revision of the document!

TransferOptions Class

Defines options for file transfers.

Advertisement

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.
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.
TransferMode TransferMode Transfer mode. Possible values are TransferMode.Binary (default), TransferMode.Ascii and TransferMode.Automatic (based on file extension).
TransferResumeSupport ResumeSupport Configures automatic resume/transfer to temporary filename. Read-only (set properties of returned TransferResumeSupport instance).
int SpeedLimit Limit transfer speed (in KB/s). This feature is available only in the latest beta release.

Advertisement

Remarks

Use instance of the class with Session.GetFiles, Session.PutFiles or Session.SynchronizeDirectories.

Example

See overall example for WinSCP .NET assembly.

Last modified: by martin