SimulateReceivedXoff Method

Causes transmission to act as if an XOFF character has been received.

Syntax

[Visual Basic]
object.SimulateReceivedXoff

[C#]
object.SimulateReceivedXoff()

[C++]
object->SimulateReceivedXoff()

Parameters

object

An object expression that evaluates to a PortController object.

Return Value

None

Remarks

This method simulates the receipt of an Xoff character from a remote device. This suspends the sending of data from the transmission queue to the remote device.

Errors

Calling the SimulateReceivedXoff method while the port is closed is not permitted and will cause PortController to throw a "Port is closed" exception.

Example

[Visual Basic]
myPortController.SimulateReceivedXoff


[C#]
myPortController.SimulateReceivedXoff();


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

See Also