Compartilhar via


PurgeComm

Windows Mobile SupportedWindows Embedded CE Supported

9/8/2008

Esta função pode descartar todos os caracteres da saída ou buffer de entrada de um recurso de comunicação especificada.

Ele também pode finalizar pendente ler ou operações de gravação no recurso.

Syntax

BOOL PurgeComm(
  HANDLE hFile,
  DWORD dwFlags
);

Parameters

  • hFile
    [no] Identificador para o recurso de comunicação.

    A função CreateFile retorna esse identificador.

  • dwFlags
    [no] Especifica a ação seja. A seguinte tabela mostra os valores possíveis.

    Valor Descrição

    PURGE_RXABORT

    Finaliza pendente sobreposto ler operações e retorna imediatamente, mesmo se a ler as operações não foram concluídas.

    PURGE_RXCLEAR

    Limpa o buffer de entrada, se o driver de dispositivo tiver um.

    PURGE_TXABORT

    Finaliza pendente sobreposto operações de gravação e retorna imediatamente, mesmo se as operações de gravação não tem sido concluídas.

    PURGE_TXCLEAR

    Limpa a reserva saída, se o driver de dispositivo tiver um.

Return Value

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

Remarks

Se usa um segmento PurgeComm Para liberado um buffer de saída, os caracteres excluídos não são transmitidos.

Para vazio a reserva saída ao garantir que o conteúdo é transmitido, chamar a função FlushFileBuffers (uma operação síncrona).

FlushFileBuffers é assunto para fluxo controle mas não para gravar tempos limite, e ela não retorna até que todos pendente gravar operações tenham sido transmitidas.

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

Other Resources

CreateFile
FlushFileBuffers