Differences
This shows you the differences between the selected revisions of the page.
| library_transfereventargs 2012-01-04 | library_transfereventargs 2022-06-16 (current) | ||
| Line 1: | Line 1: | ||
| - | ====== TransferArgs Class ====== | + | ====== TransferEventArgs Class ====== |
| Provides data for file transfer event. | Provides data for file transfer event. | ||
| - | |||
| - | &future_feature | ||
| ===== Syntax ===== | ===== Syntax ===== | ||
| Namespace: ''WinSCP'' | Namespace: ''WinSCP'' | ||
| - | <code csharp> | + | <code csharp *> |
| - | public sealed class TransferArgs : FileOperationEventArgs | + | public sealed class TransferEventArgs : FileOperationEventArgs |
| + | </code> | ||
| + | |||
| + | <code vbnet *> | ||
| + | Public NotInheritable Class TransferEventArgs | ||
| + | Inherits FileOperationEventArgs | ||
| </code> | </code> | ||
| ===== Properties ===== | ===== Properties ===== | ||
| ^ Name ^ Description ^ | ^ Name ^ Description ^ | ||
| - | | [[library_chmodeventargs|ChmodEventArgs]] Chmod | Result of setting permissions of remote files. Used for uploads only and only, if setting permissions was requested (see ''[[library_transferoptions|TransferOptions.Permissions]]''). | | + | | [[library_chmodeventargs|ChmodEventArgs]] ==Chmod== | Result of setting permissions of remote files. Used for uploads only and only, if setting permissions was requested (see ''[[library_transferoptions#filepermissions|TransferOptions.FilePermissions]]''). Read-only. | |
| - | | string Destination | Full path to target directory of the transfer (local path for downloads, remote path for uploads). | | + | | string Destination | Full path to target file of the transfer (local path for downloads, remote path for uploads). Read-only. | |
| - | | [[library_sessionremoteexception|SessionRemoteException]] Error | Error (if any) that occured during operation. ''null'', if operation succeeded. See also [[library_session#results|Capturing results of operations]]. (Inherited from ''[[library_operationeventargs|OperationEventArgs]]''.) | | + | | [[library_sessionremoteexception|SessionRemoteException]] ==Error== | Error (if any) that occured during operation. ''null'', if operation succeeded. See also [[library_session#results|Capturing results of operations]]. Read-only. (Inherited from ''[[library_operationeventargs|OperationEventArgs]]''.) | |
| - | | string FileName | Full path to a file that is subject of the operation. (Inherited from ''[[library_fileoperationeventargs|FileOperationEventArgs]]''.) | | + | | string ==FileName== | Full path to a file that is subject of the operation. Read-only. (Inherited from ''[[library_fileoperationeventargs|FileOperationEventArgs]]''.) | |
| - | | [[library_removaleventargs|RemovalEventArgs]] Removal | Result of removing source file. Used only, if removing source file was requested (see ''remove'' argument of ''[[library_session_getfiles|Session.GetFiles]]'' and ''[[library_session_putfiles|Session.PutFiles]]''). | | + | | string ==Length== | Number of bytes transferred. | |
| - | | [[library_toucheventargs|TouchEventArgs]] Touch | Result of setting timestamp. Used only, if setting timestamp was requested (see ''[[library_transferoptions|TransferOptions.PreserveTimestamp]]''). | | + | | [[library_removaleventargs|RemovalEventArgs]] ==Removal== | Result of removing source file. Used only, if removing source file was requested (see ''remove'' argument of ''[[library_session_getfiles|Session.GetFiles]]'' and ''[[library_session_putfiles|Session.PutFiles]]''). Read-only. | |
| + | | ProgressSide ==Side== | Origin of the transfer. ''ProgressSide.Local'' for uploads, ''ProgressSide.Remote'' for downloads. Read-only. | | ||
| + | | [[library_toucheventargs|TouchEventArgs]] ==Touch== | Result of setting timestamp. Used for uploads only and only, if setting timestamp was requested (see ''[[library_transferoptions#preservetimestamp|TransferOptions.PreserveTimestamp]]''). Read-only. | | ||
| ===== Remarks ===== | ===== Remarks ===== | ||
| This class is: | This class is: | ||
| * Used by ''[[library_session_filetransferred|Session.FileTransferred]]'' event; | * Used by ''[[library_session_filetransferred|Session.FileTransferred]]'' event; | ||
| - | * Referenced by ''[[library_operationresult|OperationResult<TransferArgs>]]'' returned by ''[[library_session_getfiles|Session.GetFiles]]'' and ''[[library_session_putfiles|Session.PutFiles]]''; | + | * Referenced by ''[[library_transferoperationresult|TransferOperationResult]]'' returned by ''[[library_session_getfiles|Session.GetFiles]]'' and ''[[library_session_putfiles|Session.PutFiles]]''; |
| * Referenced by ''[[library_synchronizationresult|SynchronizationResult]]'' returned by ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]''. | * Referenced by ''[[library_synchronizationresult|SynchronizationResult]]'' returned by ''[[library_session_synchronizedirectories|Session.SynchronizeDirectories]]''. | ||
| - | ~~NOTOC~~ | + | ===== Example ===== |
| + | See [[library#example|overall example for WinSCP .NET assembly]] or ''[[library_session_synchronizedirectories#example|Session.SynchronizeDirectories]]''. | ||