COMSTAT (Compact 2013)

  • Article

3/28/2014

This structure contains communication device data.

This structure is filled by the ClearCommError function.

Syntax

typedef struct _COMSTAT {
  DWORD fCtsHold :1;
  DWORD fDsrHold :1;
  DWORD fRlsdHold :1;
  DWORD fXoffHold :1;
  DWORD fXoffSent :1;
  DWORD fEof :1;
  DWORD fTxim :1;
  DWORD fReserved :25;
  DWORD cbInQue;
  DWORD cbOutQue;
} COMSTAT, *LPCOMSTAT;

Members

  • fCtsHold
    Specifies if the transmission is waiting to receive the clear-to-send (CTS) signal. If this member is set to TRUE, the transmission is waiting.
  • fDsrHold
    Specifies if the transmission is waiting to receive the data-set-ready (DSR) signal. If this member is set to TRUE, the transmission is waiting.
  • fRlsdHold
    Specifies whether the transmission is waiting to receive the receive-line-signal-detect (RLSD) signal. If this member is set to TRUE, the transmission is waiting.
  • fXoffHold
    Specifies whether the transmission is waiting because the XOFF character was received. If this member is set to TRUE, the transmission is waiting.

  • fXoffSent
    Specifies whether the transmission is waiting because the XOFF character was transmitted. If this member is set to TRUE, the transmission is waiting.

    Transmission stops when the XOFF character is transmitted to a system that takes the next character as XON, regardless of the actual character.

  • fEof
    Specifies whether the end-of-file (EOF) character has been received. If this member is set to TRUE, the EOF character has been received.
  • fTxim
    If this member is set to TRUE, a character queued for transmission has come to the communication device from the TransmitCommChar function. The communication device transmits such a character ahead of other characters in the device's output buffer.
  • fReserved
    Reserved.
  • cbInQue
    Specifies the number of bytes received by the serial provider, but not yet read by ReadFile.
  • cbOutQue
    Specifies the number of bytes of user data remaining to be transmitted for all write operations.

Requirements

Header

winbase.h

See Also

Reference

Serial Communications Structures
ClearCommError
TransmitCommChar

Other Resources

ReadFile