PurgeComm 函式 (winbase.h)

  • 發行項

捨棄指定通訊資源的輸出或輸入緩衝區中的所有字元。 它也可以終止資源的暫止讀取或寫入作業。

語法

BOOL PurgeComm(
  [in] HANDLE hFile,
  [in] DWORD  dwFlags
);

參數

[in] hFile

通訊資源的控制碼。 CreateFile函式會傳回這個控制碼。

[in] dwFlags

此參數可以是下列一或多個值。

值 意義
PURGE_RXABORT
0x0002
 終止所有未處理的重迭讀取作業，並立即傳回，即使尚未完成讀取作業也一樣。
PURGE_RXCLEAR
0x0008
 如果設備磁碟機有一個) ，請清除輸入緩衝區 (。
PURGE_TXABORT
0x0001
 終止所有未處理的重迭寫入作業，並立即傳回，即使尚未完成寫入作業也一樣。
PURGE_TXCLEAR
0x0004
 如果設備磁碟機有一個) ，請清除輸出緩衝區 (。

傳回值

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

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

備註

如果執行緒使用 PurgeComm 排清輸出緩衝區，則不會傳輸已刪除的字元。 若要在確保傳輸內容時清空輸出緩衝區，請在同步作業 (呼叫 FlushFileBuffers 函式) 。 不過請注意， FlushFileBuffers 受限於流程式控制制，但不會寫入逾時，而且在傳輸所有擱置的寫入作業之前都不會傳回。

規格需求

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

另請參閱

通訊函式

通訊資源

CreateFile