SetCommMask

This function specifies a set of events to be monitored for a communications device.

BOOL SetCommMask(
HANDLE hFile, 
DWORD dwEvtMask); 

Parameters

  • hFile
    [in] Handle to the communications device. The CreateFile function returns this handle.
  • dwEvtMask
    [in] Specifies the events to be enabled. A value of zero disables all events. This parameter can be a combination of the following values:
    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 get extended error information, call GetLastError.

Remarks

The SetCommState 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.

Requirements

Runs On Versions Defined in Include Link to
Windows CE OS 1.0 and later Winbase.h   Serdev.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CreateFile, DCB, GetCommMask, GetLastError, SetCommState, WaitCommEvent

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.