Функция GetCommMask (winbase.h)

Статья
08/27/2023

Извлекает значение маски события для указанного устройства связи.

Синтаксис

BOOL GetCommMask(
  [in]  HANDLE  hFile,
  [out] LPDWORD lpEvtMask
);

Параметры

[in] hFile

Дескриптор для устройства связи. Функция CreateFile возвращает этот дескриптор.

[out] lpEvtMask

Указатель на переменную, получающую маску событий, которые включены в данный момент. Этот параметр может быть одним или несколькими из следующих значений.

Значение	Значение
EV_BREAK 0x0040	Обнаружен разрыв на входе.
EV_CTS 0x0008	Изменено состояние сигнала CTS (от очистки до отправки).
EV_DSR 0x0010	Сигнал DSR (data-set-ready) изменил состояние.
EV_ERR 0x0080	Произошла ошибка состояния строки. Ошибки состояния строки: CE_FRAME, CE_OVERRUN и CE_RXPARITY.
EV_EVENT1 0x0800	Произошло событие первого типа поставщика.
EV_EVENT2 0x1000	Произошло событие второго типа поставщика.
EV_PERR 0x0200	Произошла ошибка принтера.
EV_RING 0x0100	Обнаружен индикатор вызова.
EV_RLSD 0x0020	Изменено состояние сигнала RLSD (получение-линия-сигнал-обнаружение).
EV_RX80FULL 0x0400	Буфер приема заполнен на 80 процентов.
EV_RXCHAR 0x0001	Символ получен и помещен во входной буфер.
EV_RXFLAG 0x0002	Символ события получен и помещен во входной буфер. Символ события указывается в структуре DCB устройства, которая применяется к последовательному порту с помощью функции SetCommState .
EV_TXEMPTY 0x0004	Последний символ в выходном буфере был отправлен.

Возвращаемое значение

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Функция GetCommMask использует переменную mask для указания набора событий, которые можно отслеживать для определенного ресурса связи. Дескриптор ресурса связи можно указать в вызове функции WaitCommEvent , которая ожидает возникновения одного из событий. Чтобы изменить маску событий ресурса связи, используйте функцию SetCommMask .

Требования

Требование	Значение
Минимальная версия клиента	Windows XP [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2003 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	winbase.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll