ClearCommError-Funktion (winbase.h)

Artikel
08/27/2023

Ruft Informationen zu einem Kommunikationsfehler ab und meldet die aktuelle status eines Kommunikationsgeräts. Die Funktion wird aufgerufen, wenn ein Kommunikationsfehler auftritt, und sie löscht das Fehlerflag des Geräts, um zusätzliche Eingabe- und Ausgabevorgänge (E/A) zu aktivieren.

Syntax

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

Parameter

[in] hFile

Ein Handle für das Kommunikationsgerät. Die CreateFile-Funktion gibt dieses Handle zurück.

[out, optional] lpErrors

Ein Zeiger auf eine Variable, die eine Maske empfängt, die den Fehlertyp angibt. Dieser Parameter kann einen oder mehrere der folgenden Werte aufweisen.

Wert	Bedeutung
CE_BREAK 0x0010	Die Hardware hat eine Unterbrechungsbedingung erkannt.
CE_FRAME 0x0008	Die Hardware hat einen Rahmenfehler erkannt.
CE_OVERRUN 0x0002	Ein Zeichenpufferüberlauf ist aufgetreten. Das nächste Zeichen geht verloren.
CE_RXOVER 0x0001	Ein Eingabepufferüberlauf ist aufgetreten. Die Kapazität des Eingabepuffers ist erschöpft, oder es wurde ein Zeichen nach dem Dateiendezeichen (EOF, end-of-file) empfangen.
CE_RXPARITY 0x0004	Die Hardware hat einen Paritätsfehler erkannt.

Die folgenden Werte werden nicht unterstützt:

[out, optional] lpStat

Ein Zeiger auf eine COMSTAT-Struktur, in der die status Informationen des Geräts zurückgegeben werden. Wenn dieser Parameter NULL ist, werden keine status Informationen zurückgegeben.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Wenn ein Kommunikationsport mit einem TRUE-Wert für das fAbortOnError-Element der DCB-Setupstruktur eingerichtet wurde, beendet die Kommunikationssoftware alle Lese- und Schreibvorgänge auf dem Kommunikationsport, wenn ein Kommunikationsfehler auftritt. Es werden keine neuen Lese- oder Schreibvorgänge akzeptiert, bis die Anwendung den Kommunikationsfehler durch Aufrufen der ClearCommError-Funktion bestätigt.

Die ClearCommError-Funktion füllt den status Puffer, auf den der lpStat-Parameter verweist, mit der aktuellen status des Kommunikationsgeräts aus, das durch den hFile-Parameter angegeben wird.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	winbase.h (Windows.h einschließen)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll