WinHttpWebSocketClose

WebSocket 接続を閉じる。

WinHttpWebSocketClose hWebSocket, usStatus, pvReason, dwReasonLength

hWebSocket : [intptr] 型: HINTERNET WebSocket へのハンドル。注: WinHttpWebSocketClose はこのハンドルを閉じない。ハンドルを閉じるには、不要になった時点で hWebSocket に対して WinHttpCloseHandle を呼び出す。
usStatus : [int] 型: USHORT クローズステータスコード。指定可能な値は WINHTTP_WEB_SOCKET_CLOSE_STATUS を参照。
pvReason : [intptr] 型: PVOID クローズの詳細な理由。
dwReasonLength : [int] 型: DWORD pvReason の長さ (バイト単位)。pvReason が NULL の場合はこれを 0 にしなければならない。値は 0 から 123 の範囲でなければならない。

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

解説

WebSocket 接続を閉じる。

[戻り値]
型: DWORD 次の例外を除いて、すべてのエラーコードは基礎となる TCP 接続が中断されたことを示す。
(以下省略)

[備考]
WinHttpWebSocketClose は WebSocket
接続を完全に閉じる。送信チャネルを閉じたまま受信チャネルを開いたままにするには WinHttpWebSocketShutdown
を使う。通常の受信操作中にクローズフレームを受信することがある。この場合 WinHttpWebSocketClose
もクローズフレームを送信する。クローズタイマーはプロパティ WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT
で設定できる。既定は 10 秒。

情報

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