XoffByte Property

Sets and returns the byte which serves as the XOFF software flow control signal.

Syntax

[Visual Basic]
object.XoffByte [ = value ]

[C#]
object.XoffByte [ = value ]

[C++]
object->XoffByte [ = value ]

Parameters

object

An object expression that evaluates to a PortController object.

value

The byte which is used as the XOFF signal during XON/XOFF handshaking.

Return Value

A Byte representing the current XOFF character.

Remarks

None

Default

19 (0x13).

Errors

None

Example

[Visual Basic]
'Set XOFF byte
myPortController.XoffByte = 41

'Get XOFF byte
Dim XoffByte As Byte
XoffByte = myPortController.XoffByte


[C#]
// Set XOFF byte
myPortController.XoffByte = 41;

// Get XOFF byte
Byte XoffByte = myPortController.XoffByte;

[C++]
// Set XOFF byte
myPortController->XoffByte = 41;

// Get XOFF byte
Byte XoffByte = myPortController->XoffByte;

See Also