UID

title

description

helpviewer_keywords

old-location

tech.root

ms.assetid

ms.date

ms.keywords

req.header

req.include-header

req.target-type

req.target-min-winverclnt

req.target-min-winversvr

req.kmdf-ver

req.umdf-ver

req.ddi-compliance

req.unicode-ansi

req.idl

req.max-support

req.namespace

req.assembly

req.type-library

req.lib

req.dll

req.irql

targetos

req.typenames

req.redist

ms.custom

f1_keywords

dev_langs

topic_type

api_type

api_location

api_name

NF:winbase.GetCommMask

GetCommMask function (winbase.h)

Retrieves the value of the event mask for a specified communications device.

EV_BREAK

EV_CTS

EV_DSR

EV_ERR

EV_EVENT1

EV_EVENT2

EV_PERR

EV_RING

EV_RLSD

EV_RX80FULL

EV_RXCHAR

EV_RXFLAG

EV_TXEMPTY

GetCommMask

GetCommMask function

_win32_getcommmask

base.getcommmask

winbase/GetCommMask

base\getcommmask.htm

base

502aa563-c783-4a98-8596-74514a5b261e

12/05/2018

EV_BREAK, EV_CTS, EV_DSR, EV_ERR, EV_EVENT1, EV_EVENT2, EV_PERR, EV_RING, EV_RLSD, EV_RX80FULL, EV_RXCHAR, EV_RXFLAG, EV_TXEMPTY, GetCommMask, GetCommMask function, _win32_getcommmask, base.getcommmask, winbase/GetCommMask

winbase.h

Windows.h

Windows

Windows XP [desktop apps \| UWP apps]

Windows Server 2003 [desktop apps \| UWP apps]

Kernel32.lib

Kernel32.dll

Windows

19H1

GetCommMask

winbase/GetCommMask

c++

APIRef

kbSyntax

DllExport

Kernel32.dll

API-MS-Win-Core-comm-l1-1-0.dll

KernelBase.dll

API-MS-Win-DownLevel-Kernel32-l1-1-0.dll

MinKernelBase.dll

GetCommMask

GetCommMask function

-description

Retrieves the value of the event mask for a specified communications device.

-parameters

-param hFile [in]

A handle to the communications device. The CreateFile function returns this handle.

-param lpEvtMask [out]

A pointer to the variable that receives a mask of events that are currently enabled. This parameter can be one or more of the following values.

Value	Meaning
EV_BREAK 0x0040	A break was detected on input.
EV_CTS 0x0008	The CTS (clear-to-send) signal changed state.
EV_DSR 0x0010	The DSR (data-set-ready) signal changed state.
EV_ERR 0x0080	A line-status error occurred. Line-status errors are CE_FRAME, CE_OVERRUN, and CE_RXPARITY.
EV_EVENT1 0x0800	An event of the first provider-specific type occurred.
EV_EVENT2 0x1000	An event of the second provider-specific type occurred.
EV_PERR 0x0200	A printer error occurred.
EV_RING 0x0100	A ring indicator was detected.
EV_RLSD 0x0020	The RLSD (receive-line-signal-detect) signal changed state.
EV_RX80FULL 0x0400	The receive buffer is 80 percent full.
EV_RXCHAR 0x0001	A character was received and placed in the input buffer.
EV_RXFLAG 0x0002	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 0x0004	The last character in the output buffer was sent.

-returns

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.

-remarks

The GetCommMask function uses a mask variable to indicate 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 modify the event mask of a communications resource, use the SetCommMask function.