Compartilhar via

Função PurgeComm (winbase.h)

  • Artigo

Descarta todos os caracteres da saída ou do buffer de entrada de um recurso de comunicação especificado. Ele também pode encerrar operações pendentes de leitura ou gravação no recurso.

Sintaxe

BOOL PurgeComm(
  [in] HANDLE hFile,
  [in] DWORD  dwFlags
);

Parâmetros

[in] hFile

Um identificador para o recurso de comunicação. A função CreateFile retorna esse identificador.

[in] dwFlags

Esse parâmetro pode usar um dos valores a seguir.

Valor Significado
PURGE_RXABORT
0x0002
 Encerra todas as operações de leitura sobrepostas pendentes e retorna imediatamente, mesmo que as operações de leitura não tenham sido concluídas.
PURGE_RXCLEAR
0x0008
 Limpa o buffer de entrada (se o driver do dispositivo tiver um).
PURGE_TXABORT
0x0001
 Encerra todas as operações de gravação sobrepostas pendentes e retorna imediatamente, mesmo que as operações de gravação não tenham sido concluídas.
PURGE_TXCLEAR
0x0004
 Limpa o buffer de saída (se o driver do dispositivo tiver um).

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 um thread usar PurgeComm para liberar um buffer de saída, os caracteres excluídos não serão transmitidos. Para esvaziar o buffer de saída, garantindo que o conteúdo seja transmitido, chame a função FlushFileBuffers (uma operação síncrona). Observe, no entanto, que FlushFileBuffers está sujeito ao controle de fluxo, mas não a tempos limite de gravação, e ele não retornará até que todas as operações de gravação pendentes tenham sido transmitidas.

Requisitos

   
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