GetCommStatus Method

Navigation:  Reference Guide > Serial Communication >

GetCommStatus Method

Previous pageReturn to chapter overviewNext page

Retrieves modem control-register values for a communication channel (direct serial connection or modem connection).

GetCommStatus(short ChannelID, long *ModemStat, VARIANT_BOOL *Result);

Parameters

ChannelID

    A channel ID (0-7) used to identify a communication channel.

ModemStat

     A long pointer to a 32-bit variable that specifies the current state of the modem control-register values. This parameter can be a combination of the following values:

Value

Comment

MS_CTS_ON

The CTS (Clear To Send) signal is on.

MS_DSR_ON

The DSR (Data Set Ready) signal is on.

MS_RING_ON

The ring indicator signal is on.

MS_RLSD_ON

The RLSD (Receive Line Signal Detect) signal is on.

Result

    If the method succeeds, the value of variable pointed to by Result is VARIANT_TRUE, otherwise the value is VARIANT_FALSE.