SetCommMask-Funktion (winbase.h)

Artikel
03/13/2024

Gibt einen Satz von Ereignissen an, die für ein Kommunikationsgerät überwacht werden sollen.

Syntax

BOOL SetCommMask(
  [in] HANDLE hFile,
  [in] DWORD  dwEvtMask
);

Parameter

[in] hFile

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

[in] dwEvtMask

Die zu aktivierenden Ereignisse. Der Wert null deaktiviert alle Ereignisse. Dieser Parameter kann einen oder mehrere der folgenden Werte aufweisen.

Wert	Bedeutung
EV_BREAK 0x0040	Bei der Eingabe wurde ein "break" erkannt.
EV_CTS 0x0008	Das CTS-Signal (Clear-to-Send) hat den Zustand geändert.
EV_DSR 0x0010	Das DSR-Signal (Data-set-ready) hat den Zustand geändert.
EV_ERR 0x0080	Es ist ein Zeilen-status-Fehler aufgetreten. Zeilen-status-Fehler werden CE_FRAME, CE_OVERRUN und CE_RXPARITY.
EV_RING 0x0100	Ein Ringindikator wurde erkannt.
EV_RLSD 0x0020	Das RLSD-Signal (receive-line-signal-detect) hat den Zustand geändert.
EV_RXCHAR 0x0001	Ein Zeichen wurde empfangen und im Eingabepuffer platziert.
EV_RXFLAG 0x0002	Das Ereigniszeichen wurde empfangen und im Eingabepuffer platziert. Das Ereigniszeichen wird in der DCB-Struktur des Geräts angegeben, die mithilfe der SetCommState-Funktion auf einen seriellen Port angewendet wird.
EV_TXEMPTY 0x0004	Das letzte Zeichen im Ausgabepuffer wurde gesendet.

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

Die SetCommMask-Funktion gibt den Satz von Ereignissen an, die für eine bestimmte Kommunikationsressource überwacht werden können. Ein Handle für die Kommunikationsressource kann in einem Aufruf der WaitCommEvent-Funktion angegeben werden, die wartet, bis eines der Ereignisse auftritt. Verwenden Sie die GetCommMask-Funktion , um die aktuelle Ereignismaske einer Kommunikationsressource abzurufen.

Beispiele

Ein Beispiel finden Sie unter Überwachen von Kommunikationsereignissen.

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