PurgeComm-Funktion (winbase.h)

  • Artikel

Verwirft alle Zeichen aus dem Ausgabe- oder Eingabepuffer einer angegebenen Kommunikationsressource. Außerdem können ausstehende Lese- oder Schreibvorgänge für die Ressource beendet werden.

Syntax

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

Parameter

[in] hFile

Ein Handle für die Kommunikationsressource. Die CreateFile-Funktion gibt dieses Handle zurück.

[in] dwFlags

Dieser Parameter kann einen oder mehrere der folgenden Werte aufweisen.

Wert Bedeutung
PURGE_RXABORT
0x0002
 Beendet alle ausstehenden überlappenden Lesevorgänge und gibt sofort zurück, auch wenn die Lesevorgänge noch nicht abgeschlossen wurden.
PURGE_RXCLEAR
0x0008
 Löscht den Eingabepuffer (sofern der Gerätetreiber über einen verfügt).
PURGE_TXABORT
0x0001
 Beendet alle ausstehenden überlappenden Schreibvorgänge und gibt sofort zurück, auch wenn die Schreibvorgänge noch nicht abgeschlossen wurden.
PURGE_TXCLEAR
0x0004
 Löscht den Ausgabepuffer (sofern der Gerätetreiber über einen verfügt).

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 Thread PurgeComm verwendet, um einen Ausgabepuffer zu leeren, werden die gelöschten Zeichen nicht übertragen. Um den Ausgabepuffer zu leeren und gleichzeitig sicherzustellen, dass der Inhalt übertragen wird, rufen Sie die FlushFileBuffers-Funktion auf (ein synchroner Vorgang). Beachten Sie jedoch, dass FlushFileBuffers der Flusssteuerung, aber nicht dem Schreiben von Timeouts unterliegt und erst zurückgegeben wird, wenn alle ausstehenden Schreibvorgänge übertragen wurden.

Anforderungen

   
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 (einschließlich Windows.h)
Bibliothek Kernel32.lib
DLL Kernel32.dll

Siehe auch

Kommunikationsfunktionen

Kommunikationsressourcen

CreateFile