KsGetCommMask

此函式是否可用依裝置支援項目而定。

檢索指定通訊裝置的事件遮罩值。

語法

BOOL KsGetCommMask(
     HANDLE hFile,
     LPDWORD lpEvtMask
);

參數

hFile：通訊裝置的控制代碼，KsCreateComm 函式回傳此控制代碼。

lpEvtMask：接收當前啟用的事件遮罩的變數指標，此參數可為下列一個或多個值：

值	說明
EV_BREAK 0x0040	輸入偵測到中斷。
EV_CTS 0x0008	清除發送 (clear-to-send, CTS) 訊號狀態改變。
EV_DSR 0x0010	資料集備妥 (data-set-ready, DSR) 訊號狀態改變。
EV_ERR 0x0080	發生線路狀態錯誤。線路狀態錯誤為 CE_FRAME、CE_OVERRUN 與CE_RXPARITY。
EV_EVENT1 0x0800	發生了第一個指定供應商類型的事件。
EV_EVENT2 0x1000	發生了第二個指定供應商類型的事件。
EV_PERR 0x0200	發生印表機錯誤。
EV_RING 0x0100	偵測到振鈴指示器。
EV_RLSD 0x0020	接收線路訊號檢測 (receive-line-signal-detect, RLSD ) 訊號狀態改變。
EV_RX80FULL 0x0400	接收緩衝區已達 80%。
EV_RXCHAR 0x0001	字元已接收且置於輸入緩衝區。
EV_RXFLAG 0x0002	事件字元已接收且置於輸入緩衝區，事件字元在裝置的 DCB 結構中指定，其使用 KsSetCommState 套用至串聯埠。
EV_TXEMPTY 0x0004	輸出緩衝區的最後一個字元已傳送。

回傳值

若函式執行成功將回傳 TRUE；失敗將回傳 FALSE。欲獲取延伸錯誤資訊請呼叫 GetLastError。

備註

KsGetCommMask 函式使用遮罩變數來指示可為特定通訊資源監視的事件集，可在呼叫 KsWaitCommEvent 函式中指定通訊資源的控制代碼，等待其一事件發生，欲修改通訊資源之事件遮罩，請使用 KsSetCommMask 函式。

範例

N/A

使用需求

參見