GetCommMask 函式 (winbase.h)

擷取指定通訊裝置的事件遮罩值。

語法

BOOL GetCommMask(
  [in]  HANDLE  hFile,
  [out] LPDWORD lpEvtMask
);

[in] hFile

通訊裝置的句柄。 CreateFile 函式會傳回這個句柄。

[out] lpEvtMask

變數的指標，可接收目前啟用之事件的遮罩。此參數可以是下列一或多個值。

值	意義
EV_BREAK 0x0040	在輸入時偵測到中斷。
EV_CTS 0x0008	CTS (清除傳送) 訊號已變更狀態。
EV_DSR 0x0010	DSR (數據集就緒) 訊號變更狀態。
EV_ERR 0x0080	發生行狀態錯誤。行狀態錯誤CE_FRAME、CE_OVERRUN和CE_RXPARITY。
EV_EVENT1 0x0800	發生第一個提供者特定類型的事件。
EV_EVENT2 0x1000	發生第二個提供者特定類型的事件。
EV_PERR 0x0200	發生印表機錯誤。
EV_RING 0x0100	偵測到鈴聲指示器 (Indicator)。
EV_RLSD 0x0020	RLSD (receive-line-signal-detect) 訊號已變更狀態。
EV_RX80FULL 0x0400	接收緩衝區已滿80%。
EV_RXCHAR 0x0001	會接收字元並放到輸入緩衝區。
EV_RXFLAG 0x0002	已接收事件字元，並將其放在輸入緩衝區中。事件字元是在裝置的 DCB 結構中指定，它會使用 ScommState 函式套用至序列埠。
EV_TXEMPTY 0x0004	輸出緩衝區中的最後一個字元已傳送。

如果函式成功，則傳回非零的值。

如果此函式失敗，則傳回值為零。若要取得擴充的錯誤資訊，請呼叫 GetLastError。

GetCommMask 函式會使用遮罩變數來指出可監視特定通訊資源的一組事件。通訊資源的句柄可以在 WaitCommEvent 函式的呼叫中指定，以等候其中一個事件發生。若要修改通訊資源的事件遮罩，請使用 SetCommMask 函式。

需求	值
最低支援的用戶端	Windows XP [傳統型應用程式 \|UWP 應用程式]
最低支援的伺服器	Windows Server 2003 [傳統型應用程式 \|UWP 應用程式]
目標平台	Windows
標頭	winbase.h (包含 Windows.h)
程式庫	Kernel32.lib
DLL	Kernel32.dll