CancelFileTransfer Method

Cancels a file transfer.

Syntax

[Visual Basic]
object.CancelFileTransfer()

[C#]
object.CancelFileTransfer()

[C++]
object->CancelFileTransfer()

Parameters

object

An object expression that evaluates to a PortController object.

Return Value

None

Remarks

• This method begins the process of cancelling the file transfer and returns immediately. Therefore, it is likely that the file transfer still ongoing when this method returns.
• After the transfer has been fully cancelled, the OnFileTransferComplete event is fired.

Errors

None

Example

[Visual Basic]
myPortController.CancelFileTransfer()


[C#]
myPortController.CancelFileTransfer();


[C++]
myPortController->CancelFileTransfer();

See Also