Win32 API 日本語リファレンス
ホームNetworking.WinInet › HttpWebSocketQueryCloseStatus

HttpWebSocketQueryCloseStatus

関数
WebSocketのクローズステータスと理由を取得する。
DLLWININET.dll呼出規約winapi

シグネチャ

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

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

パラメーター

名前方向
hWebSocketvoid*in
pusStatusWORD*out
pvReasonvoid*outoptional
dwReasonLengthDWORDin
pdwReasonLengthConsumedDWORD*inout

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL HttpWebSocketQueryCloseStatus(
    void* hWebSocket,
    WORD* pusStatus,
    void* pvReason,   // optional
    DWORD dwReasonLength,
    DWORD* pdwReasonLengthConsumed
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", ExactSpelling = true)]
static extern bool HttpWebSocketQueryCloseStatus(
    IntPtr hWebSocket,   // void*
    out ushort pusStatus,   // WORD* out
    IntPtr pvReason,   // void* optional, out
    uint dwReasonLength,   // DWORD
    ref uint pdwReasonLengthConsumed   // DWORD* in/out
);
<DllImport("WININET.dll", ExactSpelling:=True)>
Public Shared Function HttpWebSocketQueryCloseStatus(
    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 Boolean
End Function
' hWebSocket : void*
' pusStatus : WORD* out
' pvReason : void* optional, out
' dwReasonLength : DWORD
' pdwReasonLengthConsumed : DWORD* in/out
Declare PtrSafe Function HttpWebSocketQueryCloseStatus Lib "wininet" ( _
    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

HttpWebSocketQueryCloseStatus = ctypes.windll.wininet.HttpWebSocketQueryCloseStatus
HttpWebSocketQueryCloseStatus.restype = wintypes.BOOL
HttpWebSocketQueryCloseStatus.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('WININET.dll')
HttpWebSocketQueryCloseStatus = Fiddle::Function.new(
  lib['HttpWebSocketQueryCloseStatus'],
  [
    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 = "wininet")]
extern "system" {
    fn HttpWebSocketQueryCloseStatus(
        hWebSocket: *mut (),  // void*
        pusStatus: *mut u16,  // WORD* out
        pvReason: *mut (),  // void* optional, out
        dwReasonLength: u32,  // DWORD
        pdwReasonLengthConsumed: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll")]
public static extern bool HttpWebSocketQueryCloseStatus(IntPtr hWebSocket, out ushort pusStatus, IntPtr pvReason, uint dwReasonLength, ref uint pdwReasonLengthConsumed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_HttpWebSocketQueryCloseStatus' -Namespace Win32 -PassThru
# $api::HttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)
#uselib "WININET.dll"
#func global HttpWebSocketQueryCloseStatus "HttpWebSocketQueryCloseStatus" sptr, sptr, sptr, sptr, sptr
; HttpWebSocketQueryCloseStatus 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 "WININET.dll"
#cfunc global HttpWebSocketQueryCloseStatus "HttpWebSocketQueryCloseStatus" sptr, var, sptr, int, var
; res = HttpWebSocketQueryCloseStatus(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 方式にも切替可。
出力引数:
; BOOL HttpWebSocketQueryCloseStatus(void* hWebSocket, WORD* pusStatus, void* pvReason, DWORD dwReasonLength, DWORD* pdwReasonLengthConsumed)
#uselib "WININET.dll"
#cfunc global HttpWebSocketQueryCloseStatus "HttpWebSocketQueryCloseStatus" intptr, var, intptr, int, var
; res = HttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)
; hWebSocket : void* -> "intptr"
; pusStatus : WORD* out -> "var"
; pvReason : void* optional, out -> "intptr"
; dwReasonLength : DWORD -> "int"
; pdwReasonLengthConsumed : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procHttpWebSocketQueryCloseStatus = wininet.NewProc("HttpWebSocketQueryCloseStatus")
)

// hWebSocket (void*), pusStatus (WORD* out), pvReason (void* optional, out), dwReasonLength (DWORD), pdwReasonLengthConsumed (DWORD* in/out)
r1, _, err := procHttpWebSocketQueryCloseStatus.Call(
	uintptr(hWebSocket),
	uintptr(pusStatus),
	uintptr(pvReason),
	uintptr(dwReasonLength),
	uintptr(pdwReasonLengthConsumed),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function HttpWebSocketQueryCloseStatus(
  hWebSocket: Pointer;   // void*
  pusStatus: Pointer;   // WORD* out
  pvReason: Pointer;   // void* optional, out
  dwReasonLength: DWORD;   // DWORD
  pdwReasonLengthConsumed: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'WININET.dll' name 'HttpWebSocketQueryCloseStatus';
result := DllCall("WININET\HttpWebSocketQueryCloseStatus"
    , "Ptr", hWebSocket   ; void*
    , "Ptr", pusStatus   ; WORD* out
    , "Ptr", pvReason   ; void* optional, out
    , "UInt", dwReasonLength   ; DWORD
    , "Ptr", pdwReasonLengthConsumed   ; DWORD* in/out
    , "Int")   ; return: BOOL
●HttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed) = DLL("WININET.dll", "bool HttpWebSocketQueryCloseStatus(void*, void*, void*, dword, void*)")
# 呼び出し: HttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)
# hWebSocket : void* -> "void*"
# pusStatus : WORD* out -> "void*"
# pvReason : void* optional, out -> "void*"
# dwReasonLength : DWORD -> "dword"
# pdwReasonLengthConsumed : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。