Siemens M20 Terminal Technical Description page 183

Siemens Information and Communication Products
8.4.2.7 int GetCommError(idComDev, lpStat)
int idComDev;
COMSTAT FAR* lpStat; /* address of device-status buffer
The GetCommError function retrieves the most recent error value and current status for the specified device. When a com-
munications error occurs, Windows locks the communications port until GetCommError clears the error.
int GetCommError(idComDev, lpStat)
Parameter Description
idComDev Specifies the communications device to be examined. The OpenComm function returns this value.
lpStat Indicates the COMSTAT structure that is to receive the device status. If this parameter is NULL,
the function only returns the error values.
Return value The return value specifies the error value for the most recent communications function call to the
specified device, if GetCommError is successful.
Errors:
The return value can be a combination of the following values:
Value Meaning
CE_BREAK hardware detected a break condition.
CE_CTSTO CTS (clear to send) timeout. While a character was being transmitted, CTS was low
for the duration specified by the fCtsHold member of the COMSTAT structure.
CE_DNS parallel device was not selected.
CE_DSRTO DSR (data set ready) timeout. While a character was being transmitted, DSR was low
for the duration specified by the fDsrHold member of COMSTAT.
CE_FRAME hardware detected a framing error.
CE_IOE I/O error occurred during an attempt to communicate with a parallel device.
CE_MODE requested mode is not supported or the idComDev parameter is invalid. If set,
CE_MODE is the only valid error.
CE_OOP parallel device signalled that it is out of paper.
CE_OVERRUN character was not read from the hardware before the next character arrived. The
character was lost.
CE_PTO timeout occurred during an attempt to communicate with a parallel device.
CE_RLSDTO RLSD (receive line signal detect) timeout. While a character was being transmitted,
RLSD was low for the duration specified by the fRlsdHold member of COMSTAT.
CE_RXOVER receiving queue overflowed. There was either no room in the input queue or a cha-
racter was received after the end-of-file character was received.
CE_RXPARITY hardware detected a parity error.
CE_TXFULL transmission queue was full when a function attempted to queue a character.
Example None
Comments None
See also OpenComm, COMSTAT
Version 8 dated 15.03.00
/* communications device identifier */
*/
Application notes
A
183