This is an old revision of the document!
TransferEventArgs Class
Provides data for file transfer event.
This feature will be available only with the next release.
Syntax
Namespace: WinSCP
Advertisement
public sealed class TransferEventArgs : FileOperationEventArgs
Properties
Name | Description |
---|---|
ChmodEventArgs Chmod | Result of setting permissions of remote files. Used for uploads only and only, if setting permissions was requested (see TransferOptions.Permissions ). Read-only. |
string Destination | Full path to target file of the transfer (local path for downloads, remote path for uploads). Read-only. |
SessionRemoteException Error | Error (if any) that occured during operation. null , if operation succeeded. See also Capturing results of operations. Read-only. (Inherited from OperationEventArgs .) |
string FileName | Full path to a file that is subject of the operation. Read-only. (Inherited from FileOperationEventArgs .) |
RemovalEventArgs Removal | Result of removing source file. Used only, if removing source file was requested (see remove argument of Session.GetFiles and Session.PutFiles ). Read-only. |
TouchEventArgs Touch | Result of setting timestamp. Used only, if setting timestamp was requested (see TransferOptions.PreserveTimestamp ). Read-only. |
Remarks
This class is:
- Used by
Session.FileTransferred
event; - Referenced by
OperationResult<TransferEventArgs>
returned bySession.GetFiles
andSession.PutFiles
; - Referenced by
SynchronizationResult
returned bySession.SynchronizeDirectories
.
Advertisement
Example
See overall example for WinSCP .NET assembly or Session.SynchronizeDirectories
.