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

使用需求

参见