GetCommMask (Windows CE 5.0)
This function retrieves the event mask value for a specified communication device.
BOOLGetCommMask( HANDLEhFile, LPDWORDlpEvtMask);
Parameters
hFile
[in] Handle to the communication device.The CreateFile function returns this handle.
lpEvtMask
[out] Long pointer to the 32-bit variable to be filled with a mask of events currently enabled.The following are possible values for this parameter.
Value Description EV_BREAK A break was detected on input. EV_CTS The CTS (Clear To Send) signal changed state. EV_DSR The DSR (Data Set Ready) signal changed state. EV_ERR A line-status error occurred. Line-status errors are CE_FRAME, CE_OVERRUN, and CE_RXPARITY.
EV_RING A ring indicator was detected. EV_RLSD The RLSD (Receive Line Signal Detect) signal changed state. EV_RXCHAR A character was received and placed in the input buffer. EV_RXFLAG The event character was received and placed in the input buffer. The event character is specified in the device's DCB structure, which is applied to a serial port by using the SetCommState function.
EV_TXEMPTY The last character in the output buffer was sent.
Return Values
Nonzero indicates success.
Zero indicates failure.
To obtain extended error data, call the GetLastError function.
Remarks
The GetCommMask function uses a 32-bit mask variable to indicate the set of events that can be monitored for a particular communication resource.
A handle to the communication resource can be specified in a call to the WaitCommEvent function, which waits for an event to occur.
To modify the event mask of a communication resource, use the SetCommMask function.
Requirements
OS Versions: Windows CE 1.0 and later.
Header: Winbase.h.
Link Library: Serdev.lib.
See Also
CreateFile | SetCommMask | SetCommState | WaitCommEvent | DCB
Send Feedback on this topic to the authors