XonByte Property

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

Syntax

[Visual Basic]
object.XonByte [ = value ]

[C#]
object.XonByte [ = value ]

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

Parameters

object

An object expression that evaluates to a PortController object.

value

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

Return Value

A Byte representing the current XON character.

Remarks

None

Default

17 (0x11).

Errors

None

Example

[Visual Basic]
'Set XON byte
myPortController.XonByte = 40

'Get XON byte
Dim XonByte As Byte
XonByte = myPortController.XonByte


[C#]
// Set XON byte
myPortController.XonByte = 40;

// Get XON byte
Byte XonByte = myPortController.XonByte;

[C++]
// Set XON byte
myPortController->XonByte = 40;

// Get XON byte
Byte XonByte = myPortController->XonByte;

See Also