Funzione PurgeComm (winbase.h)

  • Articolo

Rimuove tutti i caratteri dall'output o dal buffer di input di una risorsa di comunicazione specificata. Può anche terminare operazioni di lettura o scrittura in sospeso sulla risorsa.

Sintassi

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

Parametri

[in] hFile

Handle per la risorsa di comunicazione. La funzione CreateFile restituisce questo handle.

[in] dwFlags

Questo parametro può essere uno o più dei valori seguenti.

Valore Significato
PURGE_RXABORT
0x0002
 Termina tutte le operazioni di lettura sovrapposte in sospeso e restituisce immediatamente, anche se le operazioni di lettura non sono state completate.
PURGE_RXCLEAR
0x0008
 Cancella il buffer di input (se il driver di dispositivo ne ha uno).
PURGE_TXABORT
0x0001
 Termina tutte le operazioni di scrittura sovrapposte in sospeso e restituisce immediatamente, anche se le operazioni di scrittura non sono state completate.
PURGE_TXCLEAR
0x0004
 Cancella il buffer di output (se il driver di dispositivo ne ha uno).

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

Se un thread usa PurgeComm per scaricare un buffer di output, i caratteri eliminati non vengono trasmessi. Per svuotare il buffer di output assicurandosi che il contenuto venga trasmesso, chiamare la funzione FlushFileBuffers (operazione sincrona). Si noti, tuttavia, che FlushFileBuffers è soggetto al controllo del flusso, ma non ai timeout di scrittura e non verrà restituito finché non vengono trasmesse tutte le operazioni di scrittura in sospeso.

Requisiti

   
Client minimo supportato Windows XP [app desktop | App UWP]
Server minimo supportato Windows Server 2003 [app desktop | App UWP]
Piattaforma di destinazione Windows
Intestazione winbase.h (include Windows.h)
Libreria Kernel32.lib
DLL Kernel32.dll

Vedere anche

Funzioni di comunicazione

Risorse di comunicazione

CreateFile