Función ClearCommError (winbase.h)

Artículo
03/03/2024

Recupera información sobre un error de comunicaciones e informa del estado actual de un dispositivo de comunicaciones. Se llama a la función cuando se produce un error de comunicación y borra la marca de error del dispositivo para habilitar operaciones adicionales de entrada y salida (E/S).

Sintaxis

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

Parámetros

[in] hFile

Identificador del dispositivo de comunicaciones. La función CreateFile devuelve este identificador.

[out, optional] lpErrors

Puntero a una variable que recibe una máscara que indica el tipo de error. Este parámetro puede ser uno o más de los siguientes valores.

Valor	Significado
CE_BREAK 0x0010	El hardware detectó una condición de interrupción.
CE_FRAME 0x0008	El hardware ha detectado un error de trama.
CE_OVERRUN 0x0002	Está saturado el búfer de caracteres. Falta el siguiente carácter.
CE_RXOVER 0x0001	Se ha desbordado el búfer de entrada. No hay espacio en el búfer de entrada o se ha recibido un carácter después del carácter de fin de archivo (EOF).
CE_RXPARITY 0x0004	El hardware ha detectado un error de paridad.

No se admiten los siguientes valores:

[out, optional] lpStat

Puntero a una estructura COMSTAT en la que se devuelve la información de estado del dispositivo. Si este parámetro es NULL, no se devuelve información de estado.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Si se ha configurado un puerto de comunicaciones con un valor TRUE para el miembro fAbortOnError de la estructura DCB de configuración, el software de comunicaciones finalizará todas las operaciones de lectura y escritura en el puerto de comunicaciones cuando se produzca un error de comunicación. No se aceptarán nuevas operaciones de lectura o escritura hasta que la aplicación confirme el error de comunicaciones mediante una llamada a la función ClearCommError .

La función ClearCommError rellena el búfer de estado al que apunta el parámetro lpStat con el estado actual del dispositivo de comunicaciones especificado por el parámetro hFile .

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [aplicaciones de escritorio \| aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2003 [aplicaciones de escritorio \| aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	winbase.h (incluye Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll