|
PortController.NET
OnFileTransferComplete Event
Fired upon the completion of a successful, failed, or cancelled file transfer.
Syntax
[Visual Basic]
Private Sub myPortController_OnFileTransferComplete(ByVal sender As Object, _
ByVal e As SciCom.PortController.FileTransferCompleteEventArgs) Handles _
myPortController.OnFileTransferComplete
[C#]
private void OnFileTransferComplete(object sender, SciCom.PortController.FileTransferCompleteEventArgs e)
[C++]
System::Void OnFileTransferComplete(System::Object * sender, SciCom::PortController::FileTransferCompleteEventArgs * e)
Parameters
sender
A reference to the PortController object.
e
The arguments associated with the event.
Arguments
Result: A value of type FileTransferResult indicating the result of the file transfer.
FileNames: A StringCollection containing a list of files associated with the result of the file transfer
Remarks
This event is fired with one of the following results:
| Result | Description | Contents of FileNames |
| Complete | File transfer has complete successfully | The name(s) of the file(s) transferred |
| Cancelled | File transfer was cancelled by the remote machine or by the CancelFileTransfer method | The name(s) of the file(s) successfully transferred before the transfer was cancelled |
| Timeout | File transfer timed out trying to contact the remote machine | The name(s) of the file(s) successfully transferred before the timeout |
| FileNotFound | The file specified to be sent was not found | The name of the file which could not be found (in the first item of the collection) |
| CannotWriteFileAbort | The specified receive path name is invalid or write protected | The name(s) of the file(s) successfully transferred before the error occurred |
| ErrorAbort | An error has occurred and the maximum number of retries has been exceeded. | The name(s) of the file(s) successfully transferred before the error occurred |
See Also
OnFileTransferStatusUpdate event | IsFileTransferInProgress property |
SendFileXModem method | SendFileXModem1k method |
SendFileYModem method | SendFileZModem method |
ReceiveFileXModem method | ReceiveFileXModemCRC method |
ReceiveFileYModem method | ReceiveFileZModem method |
CancelFileTransfer method
|