EvtCharReceived Event

Triggered when the event character is received in the input buffer.

Syntax

Visual Basic

Private Sub PortControllerObject_EvtCharReceived(ByVal ReadBuffer As String, ByVal NumBytesRead As Long)

Visual C++

void CMyWindowName::OnEvtCharReceivedPortcontroller(LPCTSTR ReadBuffer, long NumBytesRead)

Delphi

procedure PortControllerObjectEvtCharReceived(ASender: TObject; const ReadBuffer: WideString; NumBytesRead: Integer);

Arguments

• ReadBuffer: a C-style string that holds the data read up to the event character

• NumBytesRead: a long integer that holds number of bytes read including the event character

Remarks

• Setting the property EnableReadOnEventChar to true will cause all data up to and including the first occurrence of the event character in the receive queue to be read when the event character is received.

• If the event character is received many times in quick succession, the EvtCharReceived event may not fire each time. When using this event with automatic read enabled to process incoming data, be sure to check for "stranded" data left in the receive queue after all of the EvtCharReceived events have been fired.

• See Using PortController Events for information and instructions regarding PortController event handling.

Errors

None

See Also