EnableReadOnEventChar Property

Enables and disables reading from the receive buffer when the EventChar is received.

Syntax

[Visual Basic]
object.EnableReadOnEventChar [ = value ]

[C#]
object.EnableReadOnEventChar [ = value ]

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

Parameters

object

An object expression that evaluates to a PortController object.

value

A boolean value indicating whether the receive buffer is to be read when the EventChar is received.

Return Value

A boolean value indicating whether reading the receive queue upon receiving the event character is enabled.

Default

False

Remarks

When this property is true, upon receiving the EventChar, the receive queue is read up to and including the EventChar.

Errors

None

Example

[Visual Basic]
'Set EnableReadOnEventChar
myPortController.EnableReadOnEventChar = True

'Get EnableReadOnEventChar
Dim enableRead As Boolean
enableRead = myPortController.EnableReadOnEventChar


[C#]
// Set EnableReadOnEventChar
myPortController.EnableReadOnEventChar = true;

// Get EnableReadOnEventChar
Boolean bEnableRead = myPortController.EnableReadOnEventChar;


[C++]
// Set EnableReadOnEventChar
myPortController->EnableReadOnEventChar = true;

// Get EnableReadOnEventChar
Boolean bEnableRead = myPortController->EnableReadOnEventChar;

See Also