Função ClearCommError (winbase.h)

Artigo
08/27/2023

Recupera informações sobre um erro de comunicação e relata o status atual de um dispositivo de comunicação. A função é chamada quando ocorre um erro de comunicação e limpa o sinalizador de erro do dispositivo para habilitar operações adicionais de E/S (entrada e saída).

Sintaxe

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

Parâmetros

[in] hFile

Um identificador para o dispositivo de comunicações. A função CreateFile retorna esse identificador.

[out, optional] lpErrors

Um ponteiro para uma variável que recebe uma máscara que indica o tipo de erro. Esse parâmetro pode usar um dos valores a seguir.

Valor	Significado
CE_BREAK 0x0010	O hardware detectou uma condição de interrupção.
CE_FRAME 0x0008	O hardware detectou um erro de enquadramento.
CE_OVERRUN 0x0002	Ocorreu um estouro de buffer de caracteres. O próximo caractere foi perdido.
CE_RXOVER 0x0001	Ocorreu um estouro de buffer de entrada. Não há nenhum espaço no buffer de entrada ou um caractere foi recebido após o caractere de EOF (fim do arquivo).
CE_RXPARITY 0x0004	O hardware detectou um erro de paridade.

Não há suporte para os seguintes valores:

[out, optional] lpStat

Um ponteiro para uma estrutura COMSTAT na qual as informações de status do dispositivo são retornadas. Se esse parâmetro for NULL, nenhuma status informações será retornada.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Se uma porta de comunicação tiver sido configurada com um valor TRUE para o membro fAbortOnError da estrutura dcb de instalação, o software de comunicações encerrará todas as operações de leitura e gravação na porta de comunicações quando ocorrer um erro de comunicação. Nenhuma nova operação de leitura ou gravação será aceita até que o aplicativo reconheça o erro de comunicação chamando a função ClearCommError .

A função ClearCommError preenche o buffer de status apontado pelo parâmetro lpStat com o status atual do dispositivo de comunicações especificado pelo parâmetro hFile.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [aplicativos da área de trabalho \| aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	winbase.h (inclua Windows.h)
Biblioteca	Kernel32.lib
DLL	Kernel32.dll