EnableReadOnEventChar Property

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

Syntax

Visual Basic

object.EnableReadOnEventChar [ = value ]

Visual C++

object.GetEnableReadOnEventChar()

object.SetEnableReadOnEventChar(value)

Delphi

object.EnableReadOnEventChar [ := value ]

Example

Visual Basic

'Set EnableReadOnEventChar
myPortController.EnableReadOnEventChar = True

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

Visual C++

// Set EnableReadOnEventChar
m_myPortController.SetEnableReadOnEventChar(true);

// Get EnableReadOnEventChar
BOOL bEnableRead = m_myPortController.GetEnableReadOnEventChar();

Delphi

// Set EnableReadOnEventChar
myPortController.EnableReadOnEventChar := Ord(True);

// Get EnableReadOnEventChar
var bEnableRead: boolean;         // declare variable in the proper place
bEnableRead := myPortController.EnableReadOnEventChar <> 0;

Remarks

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

Default

FALSE

Returns

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

Errors

None

See Also