EventChar Property

Sets and returns the character which, upon entry into the receive queue, will fire an EventCharReceived event.

Syntax

[Visual Basic]
object.EventChar [ = value ]

[C#]
object.EventChar [ = value ]

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

Parameters

object

An object expression that evaluates to a PortController object.

value

The character (type Char) which, upon arrival in the receive queue, will cause an EvtCharReceived event to be fired.

Return Value

A Char indicating the event character.

Remarks

None

Default

Newline character (0xA).

Errors

None

Example

[Visual Basic]
'Set event character
myPortController.EventChar = ";"

'Get event character
Dim eventChar As Char
eventChar = myPortController.EventChar


[C#]
// Set event character
myPortController.EventChar = ';';

// Get event character
Char eventChar = myPortController.EventChar;

[C++]
// Set event character
myPortController->EventChar = ';';

// Get event character
Char eventChar = myPortController->EventChar;

See Also