Funzione ClearCommError (winbase.h)

Articolo
08/27/2023

Recupera informazioni su un errore di comunicazione e segnala lo stato corrente di un dispositivo di comunicazione. La funzione viene chiamata quando si verifica un errore di comunicazione e cancella il flag di errore del dispositivo per abilitare operazioni di input e output aggiuntive (I/O).

Sintassi

BOOL ClearCommError(
  [in]            HANDLE    hFile,
  [out, optional] LPDWORD   lpErrors,
  [out, optional] LPCOMSTAT lpStat
);

Parametri

[in] hFile

Handle per il dispositivo di comunicazione. La funzione CreateFile restituisce questo handle.

[out, optional] lpErrors

Puntatore a una variabile che riceve una maschera che indica il tipo di errore. Questo parametro può essere uno o più dei valori seguenti.

Valore	Significato
CE_BREAK 0x0010	L'hardware ha rilevato una condizione di interruzione.
CE_FRAME 0x0008	L'hardware ha rilevato un errore di frame.
CE_OVERRUN 0x0002	Si è verificato un sovraccarico del buffer di caratteri. Il carattere successivo è andato perduto.
CE_RXOVER 0x0001	Si è verificato un overflow del buffer di input. Lo spazio nel buffer di input è esaurito oppure un carattere è stato ricevuto dopo il carattere di fine file (EOF, End-Of-File).
CE_RXPARITY 0x0004	L'hardware ha rilevato un errore di parità.

I valori seguenti non sono supportati:

[out, optional] lpStat

Puntatore a una struttura COMSTAT in cui vengono restituite le informazioni sullo stato del dispositivo. Se questo parametro è NULL, non vengono restituite informazioni sullo stato.

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 è stata impostata una porta di comunicazione con un valore TRUE per il membro fAbortOnError della struttura DCB di installazione, il software di comunicazione terminerà tutte le operazioni di lettura e scrittura sulla porta di comunicazione quando si verifica un errore di comunicazione. Non verranno accettate nuove operazioni di lettura o scrittura finché l'applicazione non riconosce l'errore di comunicazione chiamando la funzione ClearCommError .

La funzione ClearCommError riempie il buffer di stato a cui punta il parametro lpStat con lo stato corrente del dispositivo di comunicazione specificato dal parametro hFile .

Requisiti

Requisito	Valore
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