SetCommMask function (winbase.h)
Specifies a set of events to be monitored for a communications device.
BOOL SetCommMask(
[in] HANDLE hFile,
[in] DWORD dwEvtMask
);
[in] hFile
A handle to the communications device. The CreateFile function returns this handle.
[in] dwEvtMask
The events to be enabled. A value of zero disables all events. This parameter can be one or more of the following values.
| Value | Meaning |
|---|---|
|
A break was detected on input. |
|
The CTS (clear-to-send) signal changed state. |
|
The DSR (data-set-ready) signal changed state. |
|
A line-status error occurred. Line-status errors are CE_FRAME, CE_OVERRUN, and CE_RXPARITY. |
|
A ring indicator was detected. |
|
The RLSD (receive-line-signal-detect) signal changed state. |
|
A character was received and placed in the input buffer. |
|
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. |
|
The last character in the output buffer was sent. |
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
The SetCommMask function specifies the set of events that can be monitored for a particular communications resource. A handle to the communications resource can be specified in a call to the WaitCommEvent function, which waits for one of the events to occur. To get the current event mask of a communications resource, use the GetCommMask function.
For an example, see Monitoring Communications Events.
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps | UWP apps] |
| Minimum supported server | Windows Server 2003 [desktop apps | UWP apps] |
| Target Platform | Windows |
| Header | winbase.h (include Windows.h) |
| Library | Kernel32.lib |
| DLL | Kernel32.dll |