Função SetCommMask (winbase.h)

Especifica um conjunto de eventos a serem monitorados para um dispositivo de comunicação.

Sintaxe

BOOL SetCommMask(
  [in] HANDLE hFile,
  [in] DWORD  dwEvtMask
);

Parâmetros

[in] hFile

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

[in] dwEvtMask

Os eventos a serem habilitados. Um valor zero desabilita todos os eventos. Esse parâmetro pode usar um dos valores a seguir.

Valor Significado
EV_BREAK
0x0040
Uma quebra na entrada foi detectada.
EV_CTS
0x0008
O sinal CTS (limpar para enviar) alterou o estado.
EV_DSR
0x0010
O sinal DSR (pronto para conjunto de dados) alterou o estado.
EV_ERR
0x0080
Ocorreu um erro de status de linha. Os erros de status de linha são CE_FRAME, CE_OVERRUN e CE_RXPARITY.
EV_RING
0x0100
Um indicador de anel foi detectado.
EV_RLSD
0x0020
O sinal RLSD (receive-line-signal-detect) alterou o estado.
EV_RXCHAR
0x0001
Um caractere foi recebido e colocado no buffer de entrada.
EV_RXFLAG
0x0002
O caractere de evento foi recebido e colocado no buffer de entrada. O caractere de evento é especificado na estrutura DCB do dispositivo, que é aplicada a uma porta serial usando a função SetCommState .
EV_TXEMPTY
0x0004
O último caractere no buffer de saída foi enviado.

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

A função SetCommMask especifica o conjunto de eventos que podem ser monitorados para um recurso de comunicação específico. Um identificador para o recurso de comunicações pode ser especificado em uma chamada para a função WaitCommEvent , que aguarda a ocorrência de um dos eventos. Para obter a máscara de evento atual de um recurso de comunicação, use a função GetCommMask .

Exemplos

Para obter um exemplo, consulte Monitorando eventos de comunicações.

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

Confira também

Funções de comunicação

Recursos de comunicação

CreateFile

DCB

GetCommMask

Setcommstate

WaitCommEvent