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

Статья
03/03/2024

Извлекает сведения об ошибке связи и сообщает о текущем состоянии устройства связи. Функция вызывается при возникновении ошибки связи и очищает флаг ошибки устройства для включения дополнительных операций ввода-вывода.

Синтаксис

BOOL ClearCommError(
  [in]            HANDLE    hFile,
  [out, optional] LPDWORD   lpErrors,
  [out, optional] LPCOMSTAT lpStat
);

Параметры

[in] hFile

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

[out, optional] lpErrors

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

Значение	Значение
CE_BREAK 0x0010	Оборудование обнаружило условие сбоя.
CE_FRAME 0x0008	Оборудованием обнаружена ошибка кадрирования.
CE_OVERRUN 0x0002	Переполнение буфера символов. Следующий символ потерян.
CE_RXOVER 0x0001	Переполнение входного буфера. Во входном буфере нет места, или после символа конца файла (EOF) получен еще один символ.
CE_RXPARITY 0x0004	Оборудованием обнаружена ошибка четности.

Следующие значения не поддерживаются:

[out, optional] lpStat

Указатель на структуру COMSTAT , в которой возвращаются сведения о состоянии устройства. Если этот параметр имеет значение NULL, сведения о состоянии не возвращаются.

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

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

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

Если для порта связи задано значение TRUE для члена fAbortOnError структуры DCB установки, программное обеспечение для связи при возникновении ошибки связи завершит все операции чтения и записи на порте связи. Новые операции чтения или записи не будут приняты, пока приложение не подтвердит ошибку связи, вызвав функцию ClearCommError .

Функция ClearCommError заполняет буфер состояния, на который указывает параметр lpStat , текущим состоянием устройства связи, указанным параметром hFile .

Требования

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