WinHttpWebSocketQueryCloseStatus

サーバーが送信したクローズステータスを取得する。

WinHttpWebSocketQueryCloseStatus hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed

hWebSocket : [intptr] 型: HINTERNET WebSocket へのハンドル。
pusStatus : [var] 型: USHORT* 戻り時に埋められるクローズステータスコードへのポインタ。指定可能な値は WINHTTP_WEB_SOCKET_CLOSE_STATUS を参照。
pvReason : [intptr] 型: PVOID 戻り時にクローズ理由を受け取るバッファへのポインタ。
dwReasonLength : [int] 型: DWORD pvReason バッファの長さ (バイト単位)。
pdwReasonLengthConsumed : [var] 型: DWORD* 消費されたバイト数。pvReason が NULL かつ dwReasonLength が 0 の場合、pdwReasonLengthConsumed には呼び出し側アプリケーションが確保する必要のあるバッファサイズが格納される。

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

解説

サーバーが送信したクローズステータスを取得する。

[戻り値]
型: DWORD 成功時は NO_ERROR。それ以外の場合はエラーコード。
（以下省略）

[備考]
WinHttpWebSocketQueryCloseStatus は WinHttpWebSocketClose が成功した後、または
WinHttpWebSocketReceive が WINHTTP_WEB_SOCKET_CLOSE_BUFFER_TYPE
を返した後にのみ呼び出す。pdwReasonLengthConsumed は 123 を超えないため、少なくとも 123
バイトのバッファを確保すれば ERROR_INSUFFICIENT_BUFFER が返ることはない。

情報