ClearCommError

9/8/2008

Essa função recupera informações sobre um erro de comunicação e relatórios de atual status de um dispositivo de comunicação.

A função é chamado quando ocorre um erro de comunicação, e ele limpa o sinalizador de erro do dispositivo para habilitar as operações E/S adicionais.

Syntax

BOOL ClearCommError(
  HANDLE hFile,
  LPDWORD lpErrors,
  LPCOMSTAT lpStat
);

Parameters

• hFile
  [no] Identificador para o dispositivo de comunicação, retornado pela função a CreateFile.

• lpErrors
  [out] Ponteiro longo para um 32-bit variável a ser preenchido com uma máscara indicando o tipo de erro.

  O seguinte é valores para esse parâmetro.

  Valor	Descrição
  CE_BREAK	O hardware detectou uma condição interromper.
  CE_FRAME	O hardware detectado uma estruturas erro. Retornado quando o bit SERIAL_LSR_FE for detectado em registrar o hardware LSR. Esta é a estruturas indicador de erro. Ela é definida sempre que o hardware detecta que o de entrada serial unidade dados não tem um válido bit parar. Esse bit estiver desmarcada lendo esta registrar: # Definir SERIAL_LSR_FE 0x08
  CE_IOE	Ocorreu um Erro E/S durante comunicação com o dispositivo.
  CE_MODE	O modo solicitado não é com suporte, ou a hFile parâmetro é inválido. Se esse valor for especificado, ele será o válido apenas erro.
  CE_OVERRUN	Um caractere-saturação do buffer ocorreu. O próximo caractere é perdido.
  CE_RXOVER	Ocorreu um estouro buffer de entrada. Não há qualquer nenhum espaço no buffer de entrada, ou um caractere recebida depois do fim - do - arquivo (EOF) caractere.
  CE_RXPARITY	O hardware detectou um erro paridade.
  CE_TXFULL	O aplicativo tentou transmitir um caractere, mas a saída reserva estava cheia.

• lpStat
  [out] Ponteiro longo para uma estrutura COMSTAT em que status informações do dispositivo são retornadas.

  Se lpStat é NULL, há informações status são retornadas.

Return Value

Nonzero indica sucesso. Zero indica falha. Para obter informações de erro estendidas, chamar a função GetLastError.

Remarks

Se uma porta de comunicação está configurada com um TRUE valor para o fAbortOnError membro da estrutura DCB instalação, o software de comunicação irá finalizar todas as operações de gravação na porta de comunicações quando ocorre um erro de comunicação e ler.

Nenhum novo ler ou operações de gravação são aceitos até que o aplicativo confirma o erro de comunicação por chamado de ClearCommError função.

O ClearCommError função preenche a reserva status apontada pelo lpStat parâmetro com o atual status do dispositivo de comunicações especificado pelo hFile parâmetro.

As estruturas indicador de erro CE_FRAME é definido sempre que o hardware detecta que o de entrada serial unidade dados não tem um válido bit parar. Esse bit estiver desmarcada lendo esta registrar: # Definir SERIAL_LSR_FE 0x08

Windows Embedded CE não suporte os códigos de erro CE_DNS, CE_OPP e CE_PTO.

Requirements

Header	winbase.h
Library	Serdev.lib
Windows Embedded CE	Windows CE 1.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later

See Also

Reference

Serial Communications Functions
ClearCommBreak
COMSTAT
DCB

Other Resources

CreateFile