Функция GetCommMask извлекает данные о значении маски события для указанного коммуникационного устройства.
Синтаксис
BOOL GetCommMask( HANDLE hFile, LPDWORD lpEvtMask ); |
hFile
[in] Дескриптор коммуникационного устройства. Функция CreateFile возвращает этот дескриптор.lpEvtMask
[out] Указатель на переменную, принимающую маску событий, которая в текущий момент включена. Этот параметр может состоять из одного или нескольких ниже перечисленных значений.
| Значение | Предназначение |
|---|---|
| EV_BREAK | Во время ввода данных было обнаружено прерывание. |
| EV_CTS | Сигнал готовности к приему (CTS) изменил состояние. |
| EV_DSR | Сигнал готовности модема (DSR) изменил состояние. |
| EV_ERR | Произошла ошибка состояния линии. Ошибкой состояния линии являются CE_FRAME, CE_OVERRUN и CE_RXPARITY. |
| EV_EVENT1 | Произошло событие первого, определяемого поставщиком, типа. |
| EV_EVENT2 | Произошло событие второго, определяемого поставщиком, типа. |
| EV_PERR | Произошла ошибка принтера. |
| EV_RING | Был обнаружен кольцевой индикатор. |
| EV_RLSD | Сигнал RLSD (детектор принимаемого линейного сигнала) изменил состояние. |
| EV_RX80FULL | Принимающийся буфер заполнен на 80 процентов. |
| EV_RXCHAR | Символ был принят и помещен в буфер ввода данных. |
| EV_RXFLAG | Символ события был принят и помещен в буфер ввода данных. Символ события определяется в структуре DCB устройства, которое обращается к последовательному порту, используя функцию SetCommState. |
| EV_TXEMPTY | Был отправлен последний символ из буфера вывода данных. |
Возвращаемые значения
Если функция завершается успешно, возвращаемое значение не нуль.
Если функция завершается ошибкой, возвращаемое значение равняется нулю. Чтобы получить дополнительную информацию об ошибке, вызовите GetLastError.
Замечания
Функция GetCommMask использует переменную маски, чтобы указывать множество событий, которые могут быть отслежены для конкретного коммуникационного ресурса. Дескриптор коммуникационного ресурса может быть определен при вызове функции WaitCommEvent, которая ожидает одно из происходящих событий. Чтобы изменить маску события коммуникационного ресурса, используйте функцию SetCommMask.
Смотри также
Обзор Коммуникационные ресурсы, Функции, используемые коммуникационными ресурсами, CreateFile, DCB, SetCommMask, WaitCommEvent
|
Размещение и совместимость GetCommMask |
||
| К |
Windows XP |
Да |
| л |
Windows 2000 Professional |
Да |
| и |
Windows NT Workstation |
Да |
| е |
Windows Me |
Да |
| н |
Windows 98 |
Да |
|
т |
Windows 95 |
Да |
| С |
Windows 2003 Server |
Да |
| е |
Windows 2000 Server |
Да |
| р |
Windows NT Server |
Да |
| в | ||
| е | ||
| р | ||
|
Используемая библиотека |
Kernel32.lib |
|
|
Заголовочный файл |
||
|
- объявлено в |
Winbase.h |
|
|
- включено в |
Windows.h |
|
|
Unicode |
- |
|
|
Замечания по платформе |
Не имеется |
|