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状態を問い合わせる対象のWebSocketハンドル。
pusStatusWORD*out受信したクローズ状態コードを受け取るWORDへのポインタ。
pvReasonvoid*outoptional受信したクローズ理由を格納するバッファへのポインタ。
dwReasonLengthDWORDinpvReasonバッファのサイズ(バイト)。
pdwReasonLengthConsumedDWORD*inout実際に書き込まれた理由データのバイト数を受け取るDWORDへのポインタ。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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)。
const std = @import("std");

extern "wininet" fn HttpWebSocketQueryCloseStatus(
    hWebSocket: ?*anyopaque, // void*
    pusStatus: [*c]u16, // WORD* out
    pvReason: ?*anyopaque, // void* optional, out
    dwReasonLength: u32, // DWORD
    pdwReasonLengthConsumed: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc HttpWebSocketQueryCloseStatus(
    hWebSocket: pointer,  # void*
    pusStatus: ptr uint16,  # WORD* out
    pvReason: pointer,  # void* optional, out
    dwReasonLength: uint32,  # DWORD
    pdwReasonLengthConsumed: ptr uint32  # DWORD* in/out
): int32 {.importc: "HttpWebSocketQueryCloseStatus", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int HttpWebSocketQueryCloseStatus(
    void* hWebSocket,   // void*
    ushort* pusStatus,   // WORD* out
    void* pvReason,   // void* optional, out
    uint dwReasonLength,   // DWORD
    uint* pdwReasonLengthConsumed   // DWORD* in/out
);
ccall((:HttpWebSocketQueryCloseStatus, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt16}, Ptr{Cvoid}, UInt32, Ptr{UInt32}),
      hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)
# hWebSocket : void* -> Ptr{Cvoid}
# pusStatus : WORD* out -> Ptr{UInt16}
# pvReason : void* optional, out -> Ptr{Cvoid}
# dwReasonLength : DWORD -> UInt32
# pdwReasonLengthConsumed : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t HttpWebSocketQueryCloseStatus(
    void* hWebSocket,
    uint16_t* pusStatus,
    void* pvReason,
    uint32_t dwReasonLength,
    uint32_t* pdwReasonLengthConsumed);
]]
local wininet = ffi.load("wininet")
-- wininet.HttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)
-- hWebSocket : void*
-- pusStatus : WORD* out
-- pvReason : void* optional, out
-- dwReasonLength : DWORD
-- pdwReasonLengthConsumed : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const HttpWebSocketQueryCloseStatus = lib.func('__stdcall', 'HttpWebSocketQueryCloseStatus', 'int32_t', ['void *', 'uint16_t *', 'void *', 'uint32_t', 'uint32_t *']);
// HttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)
// hWebSocket : void* -> 'void *'
// pusStatus : WORD* out -> 'uint16_t *'
// pvReason : void* optional, out -> 'void *'
// dwReasonLength : DWORD -> 'uint32_t'
// pdwReasonLengthConsumed : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  HttpWebSocketQueryCloseStatus: { parameters: ["pointer", "pointer", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.HttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed)
// hWebSocket : void* -> "pointer"
// pusStatus : WORD* out -> "pointer"
// pvReason : void* optional, out -> "pointer"
// dwReasonLength : DWORD -> "u32"
// pdwReasonLengthConsumed : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t HttpWebSocketQueryCloseStatus(
    void* hWebSocket,
    uint16_t* pusStatus,
    void* pvReason,
    uint32_t dwReasonLength,
    uint32_t* pdwReasonLengthConsumed);
C, "WININET.dll");
// $ffi->HttpWebSocketQueryCloseStatus(hWebSocket, pusStatus, pvReason, dwReasonLength, pdwReasonLengthConsumed);
// hWebSocket : void*
// pusStatus : WORD* out
// pvReason : void* optional, out
// dwReasonLength : DWORD
// pdwReasonLengthConsumed : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class);
    boolean HttpWebSocketQueryCloseStatus(
        Pointer hWebSocket,   // void*
        ShortByReference pusStatus,   // WORD* out
        Pointer pvReason,   // void* optional, out
        int dwReasonLength,   // DWORD
        IntByReference pdwReasonLengthConsumed   // DWORD* in/out
    );
}
@[Link("wininet")]
lib LibWININET
  fun HttpWebSocketQueryCloseStatus = HttpWebSocketQueryCloseStatus(
    hWebSocket : Void*,   # void*
    pusStatus : UInt16*,   # WORD* out
    pvReason : Void*,   # void* optional, out
    dwReasonLength : UInt32,   # DWORD
    pdwReasonLengthConsumed : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef HttpWebSocketQueryCloseStatusNative = Int32 Function(Pointer<Void>, Pointer<Uint16>, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef HttpWebSocketQueryCloseStatusDart = int Function(Pointer<Void>, Pointer<Uint16>, Pointer<Void>, int, Pointer<Uint32>);
final HttpWebSocketQueryCloseStatus = DynamicLibrary.open('WININET.dll')
    .lookupFunction<HttpWebSocketQueryCloseStatusNative, HttpWebSocketQueryCloseStatusDart>('HttpWebSocketQueryCloseStatus');
// hWebSocket : void* -> Pointer<Void>
// pusStatus : WORD* out -> Pointer<Uint16>
// pvReason : void* optional, out -> Pointer<Void>
// dwReasonLength : DWORD -> Uint32
// pdwReasonLengthConsumed : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpWebSocketQueryCloseStatus"
  c_HttpWebSocketQueryCloseStatus :: Ptr () -> Ptr Word16 -> Ptr () -> Word32 -> Ptr Word32 -> IO CInt
-- hWebSocket : void* -> Ptr ()
-- pusStatus : WORD* out -> Ptr Word16
-- pvReason : void* optional, out -> Ptr ()
-- dwReasonLength : DWORD -> Word32
-- pdwReasonLengthConsumed : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let httpwebsocketqueryclosestatus =
  foreign "HttpWebSocketQueryCloseStatus"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* hWebSocket : void* -> (ptr void) *)
(* pusStatus : WORD* out -> (ptr uint16_t) *)
(* pvReason : void* optional, out -> (ptr void) *)
(* dwReasonLength : DWORD -> uint32_t *)
(* pdwReasonLengthConsumed : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("HttpWebSocketQueryCloseStatus" http-web-socket-query-close-status :convention :stdcall) :int32
  (h-web-socket :pointer)   ; void*
  (pus-status :pointer)   ; WORD* out
  (pv-reason :pointer)   ; void* optional, out
  (dw-reason-length :uint32)   ; DWORD
  (pdw-reason-length-consumed :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpWebSocketQueryCloseStatus = Win32::API::More->new('WININET',
    'BOOL HttpWebSocketQueryCloseStatus(LPVOID hWebSocket, LPVOID pusStatus, LPVOID pvReason, DWORD dwReasonLength, LPVOID pdwReasonLengthConsumed)');
# my $ret = $HttpWebSocketQueryCloseStatus->Call($hWebSocket, $pusStatus, $pvReason, $dwReasonLength, $pdwReasonLengthConsumed);
# hWebSocket : void* -> LPVOID
# pusStatus : WORD* out -> LPVOID
# pvReason : void* optional, out -> LPVOID
# dwReasonLength : DWORD -> DWORD
# pdwReasonLengthConsumed : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。