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

使用需求

參見