About PortController
Introduction
Purchasing PortController
Redistributing PortController
License Agreement
Support
Getting Started
How to Use PortController
PortController Sample Projects
Handling PortController Errors
Reference
Properties
AvailableSystemPorts
BaudRate Property
Break Property
BytesUsedRQ Property
BytesUsedTQ Property
Cd Property
Cts Property
DataBits Property
Dsr Property
Dtr Property
DtrDsr Property
EnableReadOnEventChar Property
EventChar Property
ForceBeginInvokeEventFiring Property
IsOpen Property
IsFileTransferInProgress Property
Parity Property
PortHandle Property
PortName Property
ReceiveBufferSize Property
Ring Property
Rts Property
RtsCts Property
StopBits Property
SystemPorts Property
TraceOutput Property
TransmitBufferSize
XoffByte Property
XonByte Property
XonXoff Property
Methods
CancelFileTransfer Method
ClearRQ Method
ClearTQ Method
Close Method
GetErrorStatus Method
Open Method
Read Method
ReadBinary Method
ReceiveFileXModem Method
ReceiveFileXModemCRC Method
ReceiveFileYModem Method
ReceiveFileZModem Method
SendFileXModem Method
SendFileXModem1k Method
SendFileYModem Method
SendFileZModem Method
SimulateReceivedXoff Method
SimulateReceivedXon Method
Write Method
WriteBinary Method
Events
OnBreakSignal Event
OnCdToggle Event
OnCtsToggle Event
OnDataReceived Event
OnDsrToggle Event
OnError Event
OnEventCharReceived Event
OnFileTransferComplete Event
OnFileTransferStatusUpdate Event
OnRing Event
OnTQEmpty Event

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:
ResultDescriptionContents of FileNames
CompleteFile transfer has complete successfullyThe name(s) of the file(s) transferred
CancelledFile transfer was cancelled by the remote machine or by the CancelFileTransfer methodThe name(s) of the file(s) successfully transferred before the transfer was cancelled
TimeoutFile transfer timed out trying to contact the remote machineThe name(s) of the file(s) successfully transferred before the timeout
FileNotFoundThe file specified to be sent was not foundThe name of the file which could not be found (in the first item of the collection)
CannotWriteFileAbortThe specified receive path name is invalid or write protectedThe name(s) of the file(s) successfully transferred before the error occurred
ErrorAbortAn 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