PurgeComm

指定した通信リソースの出力バッファまたは入力バッファからすべての文字を破棄する。また、リソース上の保留中の読み取りまたは書き込み操作を終了することもできる。

PurgeComm hFile, dwFlags

hFile : [intptr] 通信リソースのハンドル。CreateFile 関数がこのハンドルを返す。
dwFlags : [int] 

(プラグイン / モジュール : kernel32.dll)

解説

指定した通信リソースの出力バッファまたは入力バッファからすべての文字を破棄する。また、リソース上の保留中の読み取りまたは書き込み操作を終了することもできる。

[戻り値]
関数が成功した場合、戻り値は 0 以外である。関数が失敗した場合、戻り値は 0 である。拡張エラー情報を取得するには
GetLastError を呼ぶ。

[備考]
スレッドが PurgeComm
を使って出力バッファをフラッシュした場合、削除された文字は送信されない。出力バッファを空にしながら内容が確実に送信されるようにするには、FlushFileBuffers
関数(同期操作)を呼ぶ。ただし FlushFileBuffers
はフロー制御の対象だが書き込みタイムアウトの対象ではなく、保留中のすべての書き込み操作が送信されるまで戻らない。

情報

プラグイン / モジュールkernel32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の kernel32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_kernel32_gen2.hs