KsPurgeComm

此函式是否可用依装置支援项目而定。

废除指定通讯资源的输出或输入缓冲区中的所有字符，也可终止资源上搁置的读取或写入操作。

语法

BOOL KsPurgeComm(
     HANDLE hFile,
     DWORD dwFlags
);

参数

hFile：通讯资源的控制代码，KsCreateComm 函式回传此控制代码。

dwFlags：此参数可为下列一或多个值：

值	说明
PURGE_RXABORT 0x0002	终止所有未完成的重叠读取操作并立即回传（即使读取操作尚未完成）。
PURGE_RXCLEAR 0x0008	清除输入缓冲区（若装置驱动器有）。
PURGE_TXABORT 0x0001	终止所有未完成的重叠写入操作并立即回传（即使写入操作尚未完成）。
PURGE_TXCLEAR 0x0004	清除输出缓冲区（若装置驱动器有）。

回传值

若函式执行成功将回传 TRUE；失败将回传 FALSE。欲获取延伸错误资讯请呼叫 GetLastError。

备注

若执行绪使用 KsPurgeComm 来清除输出缓冲区，已删除的字符将不会传输，欲在清空输出缓冲区时确保内容的传输，呼叫 FlushFileBuffers 函式（同步作业）。注意，FlushFileBuffers 用于流程控制而非写入逾时，且其在所有搁置的写入作业传送完成前不会转回。

范例

N/A

使用需求

参见