An NDoc Documented Class Library

FTPConnection.Downloading Event

Occurs when a file is about to be downloaded from the server.

public event FTPFileTransferEventHandler Downloading;

Event Data

The event handler receives an argument of type FTPFileTransferEventArgs containing data related to this event. The following FTPFileTransferEventArgs properties provide information specific to this event.

Property Description
Append Indicates whether or not data was appended to the remote file.
Appended Obsolete. Indicates whether or not data was appended to the remote file.
Bytes Reference to byte-array if LocalDataType is ByteArray.
BytesTransferred Number of bytes transferred.
Cancel Cancel transfer.
ConnectionInstanceNumber Identifies the pooled connection on which the task is running.
Exception The exception thrown if a transfer failed.
FileSize Obsolete. Size of remote file (see remarks)
IsGuiThread Indicates whether or not the event-handler has been invoked on the GUI thread.
LastWriteTime Last write-time of the file.
LocalDataType Type of local data source/destination.
LocalDirectory Name of the local directory (not including file-name).
LocalFile Name of the local file (without path).
LocalFileSize Size of local file (see remarks).
LocalPath Path of local file if LocalDataType is File.
RemoteDirectory Full path of remote directory.
RemoteFile Name of remote file as passed into the method that initiated the transfer.
RemoteFileName Name of remote file without the path.
RemoteFileSize Size of remote file (see remarks)
RemotePath Full path of remote file.
Resume Indicates whether or not this tranfer should be resumed.
Stream Reference to Stream if LocalDataType is Stream.
Succeeded Indicates whether or not the transfer succeeded.
TaskID Identifies the asynchronous operation within which the event was triggered (applies to asynchronous methods only).

Remarks

The FTPFileTransferEventArgs argument passed to handlers has a Cancel property, that, if set to true will result in the transfer being cancelled.

If the DownloadFile method was used to initiate the transfer then the LocalPath property may be set in order to change the path of the downloaded file.

See Also

FTPConnection Class | EnterpriseDT.Net.Ftp Namespace