Catalyst File Transfer .NET

FileTransfer.OnGetFile Event

Occurs when a file download has been initiated.

[Visual Basic]
Public Event OnGetFile As OnGetFileEventHandler
[C#]
public event OnGetFileEventHandler OnGetFile;

Event Data

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

Property Description
LocalFile Gets a value which specifies the name of the local file.
RemoteFile Gets a value which specifies the name of the remote file.

Remarks

The OnGetFile event is generated when a file transfer is initiated by calling the GetFile or GetMultipleFiles methods. This will be followed by one or more OnProgress events which will inidicate the progress of the transfer. If multiple files are being downloaded, this event will fire for each file as it is transferred.

See Also

FileTransfer Class | SocketTools Namespace