WinHttpWebSocketQueryCloseStatus 関数 (winhttp.h)

  • [アーティクル]

WinHttpWebSocketQueryCloseStatus 関数は、サーバーから送信された終了状態を取得します。

構文

WINHTTPAPI DWORD WinHttpWebSocketQueryCloseStatus(
  [in]  HINTERNET hWebSocket,
  [out] USHORT    *pusStatus,
  [out] PVOID     pvReason,
  [in]  DWORD     dwReasonLength,
  [out] DWORD     *pdwReasonLengthConsumed
);

パラメーター

[in] hWebSocket

種類: HINTERNET

WebSocket へのハンドル

[out] pusStatus

種類: USHORT*

戻り時に入力される終了状態コードへのポインター。 使用可能な値については 、「WINHTTP_WEB_SOCKET_CLOSE_STATUS 」を参照してください。

[out] pvReason

種類: PVOID

戻り値に近い理由を受け取るバッファーへのポインター。

[in] dwReasonLength

型: DWORD

pvReason バッファーの長さ (バイト単位)。

[out] pdwReasonLengthConsumed

種類: DWORD*

使用されたバイト数。 pvReason が NULL で dwReasonLength が 0 の場合、pdwReasonLengthConsumed には、呼び出し元アプリケーションによって割り当てる必要があるバッファーのサイズが格納されます。

戻り値

型: DWORD

成功にNO_ERROR。 それ以外の場合はエラー コード。

説明
ERROR_INSUFFICIENT_BUFFER
 pvReason には、閉じる理由全体を書き込むのに十分な領域がありません。
ERROR_INVALID_OPERATION
 閉じるフレームがまだ受信されていません。
ERROR_INVALID_PARAMETER
 パラメーターが無効です。

注釈

WinHttpWebSocketQueryCloseStatus は、WinHttpWebSocketClose が成功した後、または WinHttpWebSocketReceive がWINHTTP_WEB_SOCKET_CLOSE_BUFFER_TYPEを返した場合にのみ呼び出します。

pdwReasonLengthConsumed は 123 を超えることはありません。そのため、少なくとも 123 のバッファーを割り当てると 、ERROR_INSUFFICIENT_BUFFER が返されなくなります。

要件

要件 値
サポートされている最小のクライアント Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winhttp.h
Library Winhttp.lib
[DLL] Winhttp.dll

こちらもご覧ください

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpWebSocketClose

WinHttpWebSocketReceive