ホーム › Networking.WinHttp › WinHttpWebSocketQueryCloseStatus

WinHttpWebSocketQueryCloseStatus

関数

WebSocketの切断ステータスと理由を取得する。

DLLWINHTTP.dll呼出規約winapi対応OSwindows8.0

シグネチャ

// WINHTTP.dll
#include <windows.h>

DWORD WinHttpWebSocketQueryCloseStatus(
    void* hWebSocket,
    WORD* pusStatus,
    void* pvReason,   // optional
    DWORD dwReasonLength,
    DWORD* pdwReasonLengthConsumed
);

パラメーター

名前	型	方向	説明
hWebSocket	void*	in	WebSocket へのハンドル。
pusStatus	WORD*	out	戻り時に格納されるクローズステータスコードへのポインター。指定可能な値については WINHTTP_WEB_SOCKET_CLOSE_STATUS を参照してください。
pvReason	void*	outoptional	戻り時にクローズ理由を受け取るバッファーへのポインター。
dwReasonLength	DWORD	in	pvReason バッファーの長さ(バイト単位)。
pdwReasonLengthConsumed	DWORD*	inout	消費されたバイト数。pvReason が NULL で dwReasonLength が 0 の場合、pdwReasonLengthConsumed には呼び出し元アプリケーションが割り当てる必要のあるバッファーのサイズが格納されます。

戻り値の型: DWORD

公式ドキュメント

サーバーから送信されたクローズステータスを取得します。

戻り値

型: DWORD

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

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

解説(Remarks)

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WINHTTP.dll
#include <windows.h>

DWORD WinHttpWebSocketQueryCloseStatus(
    void* hWebSocket,
    WORD* pusStatus,
    void* pvReason,   // optional
    DWORD dwReasonLength,
    DWORD* pdwReasonLengthConsumed
);

[DllImport("WINHTTP.dll", ExactSpelling = true)]
static extern uint WinHttpWebSocketQueryCloseStatus(
    IntPtr hWebSocket,   // void*
    out ushort pusStatus,   // WORD* out
    IntPtr pvReason,   // void* optional, out
    uint dwReasonLength,   // DWORD
    ref uint pdwReasonLengthConsumed   // DWORD* in/out
);

<DllImport("WINHTTP.dll", ExactSpelling:=True)>
Public Shared Function WinHttpWebSocketQueryCloseStatus(
    hWebSocket As IntPtr,   ' void*
    <Out> ByRef pusStatus As UShort,   ' WORD* out
    pvReason As IntPtr,   ' void* optional, out
    dwReasonLength As UInteger,   ' DWORD
    ByRef pdwReasonLengthConsumed As UInteger   ' DWORD* in/out
) As UInteger
End Function

' hWebSocket : void*
' pusStatus : WORD* out
' pvReason : void* optional, out
' dwReasonLength : DWORD
' pdwReasonLengthConsumed : DWORD* in/out
Declare PtrSafe Function WinHttpWebSocketQueryCloseStatus Lib "winhttp" ( _
    ByVal hWebSocket As LongPtr, _
    ByRef pusStatus As Integer, _
    ByVal pvReason As LongPtr, _
    ByVal dwReasonLength As Long, _
    ByRef pdwReasonLengthConsumed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WinHttpWebSocketQueryCloseStatus = ctypes.windll.winhttp.WinHttpWebSocketQueryCloseStatus
WinHttpWebSocketQueryCloseStatus.restype = wintypes.DWORD
WinHttpWebSocketQueryCloseStatus.argtypes = [
    ctypes.POINTER(None),  # hWebSocket : void*
    ctypes.POINTER(ctypes.c_ushort),  # pusStatus : WORD* out
    ctypes.POINTER(None),  # pvReason : void* optional, out
    wintypes.DWORD,  # dwReasonLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwReasonLengthConsumed : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpWebSocketQueryCloseStatus = Fiddle::Function.new(
  lib['WinHttpWebSocketQueryCloseStatus'],
  [
    Fiddle::TYPE_VOIDP,  # hWebSocket : void*
    Fiddle::TYPE_VOIDP,  # pusStatus : WORD* out
    Fiddle::TYPE_VOIDP,  # pvReason : void* optional, out
    -Fiddle::TYPE_INT,  # dwReasonLength : DWORD
    Fiddle::TYPE_VOIDP,  # pdwReasonLengthConsumed : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winhttp")]
extern "system" {
    fn WinHttpWebSocketQueryCloseStatus(
        hWebSocket: *mut (),  // void*
        pusStatus: *mut u16,  // WORD* out
        pvReason: *mut (),  // void* optional, out
        dwReasonLength: u32,  // DWORD
        pdwReasonLengthConsumed: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINHTTP.dll")]
public static extern uint WinHttpWebSocketQueryCloseStatus(IntPtr hWebSocket, out ushort pusStatus, IntPtr pvReason, uint dwReasonLength, ref uint pdwReasonLengthConsumed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpWebSocketQueryCloseStatus' -Namespace Win32 -PassThru
# $api::WinHttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)

#uselib "WINHTTP.dll"
#func global WinHttpWebSocketQueryCloseStatus "WinHttpWebSocketQueryCloseStatus" sptr, sptr, sptr, sptr, sptr
; WinHttpWebSocketQueryCloseStatus hWebSocket, varptr(pusStatus), pvReason, dwReasonLength, varptr(pdwReasonLengthConsumed)   ; 戻り値は stat
; hWebSocket : void* -> "sptr"
; pusStatus : WORD* out -> "sptr"
; pvReason : void* optional, out -> "sptr"
; dwReasonLength : DWORD -> "sptr"
; pdwReasonLengthConsumed : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINHTTP.dll"
#cfunc global WinHttpWebSocketQueryCloseStatus "WinHttpWebSocketQueryCloseStatus" sptr, var, sptr, int, var
; res = WinHttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)
; hWebSocket : void* -> "sptr"
; pusStatus : WORD* out -> "var"
; pvReason : void* optional, out -> "sptr"
; dwReasonLength : DWORD -> "int"
; pdwReasonLengthConsumed : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINHTTP.dll"
#cfunc global WinHttpWebSocketQueryCloseStatus "WinHttpWebSocketQueryCloseStatus" sptr, sptr, sptr, int, sptr
; res = WinHttpWebSocketQueryCloseStatus(hWebSocket, varptr(pusStatus), pvReason, dwReasonLength, varptr(pdwReasonLengthConsumed))
; hWebSocket : void* -> "sptr"
; pusStatus : WORD* out -> "sptr"
; pvReason : void* optional, out -> "sptr"
; dwReasonLength : DWORD -> "int"
; pdwReasonLengthConsumed : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。