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

WebSocketGetGlobalProperty

関数
WebSocketのグローバルプロパティ値を取得する。
DLLwebsocket.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT WebSocketGetGlobalProperty(
    WEB_SOCKET_PROPERTY_TYPE eType,
    void* pvValue,
    DWORD* ulSize
);

パラメーター

名前方向説明
eTypeWEB_SOCKET_PROPERTY_TYPEin取得対象のグローバルプロパティ種別を示す列挙値。
pvValuevoid*inoutプロパティ値を受け取る出力バッファへのポインタ。
ulSizeDWORD*inout入力でバッファサイズ、出力で必要/実サイズを示す入出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WebSocketGetGlobalProperty(
    WEB_SOCKET_PROPERTY_TYPE eType,
    void* pvValue,
    DWORD* ulSize
);
[DllImport("websocket.dll", ExactSpelling = true)]
static extern int WebSocketGetGlobalProperty(
    int eType,   // WEB_SOCKET_PROPERTY_TYPE
    IntPtr pvValue,   // void* in/out
    ref uint ulSize   // DWORD* in/out
);
<DllImport("websocket.dll", ExactSpelling:=True)>
Public Shared Function WebSocketGetGlobalProperty(
    eType As Integer,   ' WEB_SOCKET_PROPERTY_TYPE
    pvValue As IntPtr,   ' void* in/out
    ByRef ulSize As UInteger   ' DWORD* in/out
) As Integer
End Function
' eType : WEB_SOCKET_PROPERTY_TYPE
' pvValue : void* in/out
' ulSize : DWORD* in/out
Declare PtrSafe Function WebSocketGetGlobalProperty Lib "websocket" ( _
    ByVal eType As Long, _
    ByVal pvValue As LongPtr, _
    ByRef ulSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WebSocketGetGlobalProperty = ctypes.windll.websocket.WebSocketGetGlobalProperty
WebSocketGetGlobalProperty.restype = ctypes.c_int
WebSocketGetGlobalProperty.argtypes = [
    ctypes.c_int,  # eType : WEB_SOCKET_PROPERTY_TYPE
    ctypes.POINTER(None),  # pvValue : void* in/out
    ctypes.POINTER(wintypes.DWORD),  # ulSize : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('websocket.dll')
WebSocketGetGlobalProperty = Fiddle::Function.new(
  lib['WebSocketGetGlobalProperty'],
  [
    Fiddle::TYPE_INT,  # eType : WEB_SOCKET_PROPERTY_TYPE
    Fiddle::TYPE_VOIDP,  # pvValue : void* in/out
    Fiddle::TYPE_VOIDP,  # ulSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "websocket")]
extern "system" {
    fn WebSocketGetGlobalProperty(
        eType: i32,  // WEB_SOCKET_PROPERTY_TYPE
        pvValue: *mut (),  // void* in/out
        ulSize: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("websocket.dll")]
public static extern int WebSocketGetGlobalProperty(int eType, IntPtr pvValue, ref uint ulSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'websocket_WebSocketGetGlobalProperty' -Namespace Win32 -PassThru
# $api::WebSocketGetGlobalProperty(eType, pvValue, ulSize)
#uselib "websocket.dll"
#func global WebSocketGetGlobalProperty "WebSocketGetGlobalProperty" sptr, sptr, sptr
; WebSocketGetGlobalProperty eType, pvValue, varptr(ulSize)   ; 戻り値は stat
; eType : WEB_SOCKET_PROPERTY_TYPE -> "sptr"
; pvValue : void* in/out -> "sptr"
; ulSize : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "websocket.dll"
#cfunc global WebSocketGetGlobalProperty "WebSocketGetGlobalProperty" int, sptr, var
; res = WebSocketGetGlobalProperty(eType, pvValue, ulSize)
; eType : WEB_SOCKET_PROPERTY_TYPE -> "int"
; pvValue : void* in/out -> "sptr"
; ulSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT WebSocketGetGlobalProperty(WEB_SOCKET_PROPERTY_TYPE eType, void* pvValue, DWORD* ulSize)
#uselib "websocket.dll"
#cfunc global WebSocketGetGlobalProperty "WebSocketGetGlobalProperty" int, intptr, var
; res = WebSocketGetGlobalProperty(eType, pvValue, ulSize)
; eType : WEB_SOCKET_PROPERTY_TYPE -> "int"
; pvValue : void* in/out -> "intptr"
; ulSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	websocket = windows.NewLazySystemDLL("websocket.dll")
	procWebSocketGetGlobalProperty = websocket.NewProc("WebSocketGetGlobalProperty")
)

// eType (WEB_SOCKET_PROPERTY_TYPE), pvValue (void* in/out), ulSize (DWORD* in/out)
r1, _, err := procWebSocketGetGlobalProperty.Call(
	uintptr(eType),
	uintptr(pvValue),
	uintptr(ulSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WebSocketGetGlobalProperty(
  eType: Integer;   // WEB_SOCKET_PROPERTY_TYPE
  pvValue: Pointer;   // void* in/out
  ulSize: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'websocket.dll' name 'WebSocketGetGlobalProperty';
result := DllCall("websocket\WebSocketGetGlobalProperty"
    , "Int", eType   ; WEB_SOCKET_PROPERTY_TYPE
    , "Ptr", pvValue   ; void* in/out
    , "Ptr", ulSize   ; DWORD* in/out
    , "Int")   ; return: HRESULT
●WebSocketGetGlobalProperty(eType, pvValue, ulSize) = DLL("websocket.dll", "int WebSocketGetGlobalProperty(int, void*, void*)")
# 呼び出し: WebSocketGetGlobalProperty(eType, pvValue, ulSize)
# eType : WEB_SOCKET_PROPERTY_TYPE -> "int"
# pvValue : void* in/out -> "void*"
# ulSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "websocket" fn WebSocketGetGlobalProperty(
    eType: i32, // WEB_SOCKET_PROPERTY_TYPE
    pvValue: ?*anyopaque, // void* in/out
    ulSize: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc WebSocketGetGlobalProperty(
    eType: int32,  # WEB_SOCKET_PROPERTY_TYPE
    pvValue: pointer,  # void* in/out
    ulSize: ptr uint32  # DWORD* in/out
): int32 {.importc: "WebSocketGetGlobalProperty", stdcall, dynlib: "websocket.dll".}
pragma(lib, "websocket");
extern(Windows)
int WebSocketGetGlobalProperty(
    int eType,   // WEB_SOCKET_PROPERTY_TYPE
    void* pvValue,   // void* in/out
    uint* ulSize   // DWORD* in/out
);
ccall((:WebSocketGetGlobalProperty, "websocket.dll"), stdcall, Int32,
      (Int32, Ptr{Cvoid}, Ptr{UInt32}),
      eType, pvValue, ulSize)
# eType : WEB_SOCKET_PROPERTY_TYPE -> Int32
# pvValue : void* in/out -> Ptr{Cvoid}
# ulSize : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WebSocketGetGlobalProperty(
    int32_t eType,
    void* pvValue,
    uint32_t* ulSize);
]]
local websocket = ffi.load("websocket")
-- websocket.WebSocketGetGlobalProperty(eType, pvValue, ulSize)
-- eType : WEB_SOCKET_PROPERTY_TYPE
-- pvValue : void* in/out
-- ulSize : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('websocket.dll');
const WebSocketGetGlobalProperty = lib.func('__stdcall', 'WebSocketGetGlobalProperty', 'int32_t', ['int32_t', 'void *', 'uint32_t *']);
// WebSocketGetGlobalProperty(eType, pvValue, ulSize)
// eType : WEB_SOCKET_PROPERTY_TYPE -> 'int32_t'
// pvValue : void* in/out -> 'void *'
// ulSize : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("websocket.dll", {
  WebSocketGetGlobalProperty: { parameters: ["i32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WebSocketGetGlobalProperty(eType, pvValue, ulSize)
// eType : WEB_SOCKET_PROPERTY_TYPE -> "i32"
// pvValue : void* in/out -> "pointer"
// ulSize : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WebSocketGetGlobalProperty(
    int32_t eType,
    void* pvValue,
    uint32_t* ulSize);
C, "websocket.dll");
// $ffi->WebSocketGetGlobalProperty(eType, pvValue, ulSize);
// eType : WEB_SOCKET_PROPERTY_TYPE
// pvValue : void* in/out
// ulSize : 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 Websocket extends StdCallLibrary {
    Websocket INSTANCE = Native.load("websocket", Websocket.class);
    int WebSocketGetGlobalProperty(
        int eType,   // WEB_SOCKET_PROPERTY_TYPE
        Pointer pvValue,   // void* in/out
        IntByReference ulSize   // DWORD* in/out
    );
}
@[Link("websocket")]
lib Libwebsocket
  fun WebSocketGetGlobalProperty = WebSocketGetGlobalProperty(
    eType : Int32,   # WEB_SOCKET_PROPERTY_TYPE
    pvValue : Void*,   # void* in/out
    ulSize : 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 WebSocketGetGlobalPropertyNative = Int32 Function(Int32, Pointer<Void>, Pointer<Uint32>);
typedef WebSocketGetGlobalPropertyDart = int Function(int, Pointer<Void>, Pointer<Uint32>);
final WebSocketGetGlobalProperty = DynamicLibrary.open('websocket.dll')
    .lookupFunction<WebSocketGetGlobalPropertyNative, WebSocketGetGlobalPropertyDart>('WebSocketGetGlobalProperty');
// eType : WEB_SOCKET_PROPERTY_TYPE -> Int32
// pvValue : void* in/out -> Pointer<Void>
// ulSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WebSocketGetGlobalProperty(
  eType: Integer;   // WEB_SOCKET_PROPERTY_TYPE
  pvValue: Pointer;   // void* in/out
  ulSize: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'websocket.dll' name 'WebSocketGetGlobalProperty';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WebSocketGetGlobalProperty"
  c_WebSocketGetGlobalProperty :: Int32 -> Ptr () -> Ptr Word32 -> IO Int32
-- eType : WEB_SOCKET_PROPERTY_TYPE -> Int32
-- pvValue : void* in/out -> Ptr ()
-- ulSize : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let websocketgetglobalproperty =
  foreign "WebSocketGetGlobalProperty"
    (int32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* eType : WEB_SOCKET_PROPERTY_TYPE -> int32_t *)
(* pvValue : void* in/out -> (ptr void) *)
(* ulSize : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library websocket (t "websocket.dll"))
(cffi:use-foreign-library websocket)

(cffi:defcfun ("WebSocketGetGlobalProperty" web-socket-get-global-property :convention :stdcall) :int32
  (e-type :int32)   ; WEB_SOCKET_PROPERTY_TYPE
  (pv-value :pointer)   ; void* in/out
  (ul-size :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WebSocketGetGlobalProperty = Win32::API::More->new('websocket',
    'int WebSocketGetGlobalProperty(int eType, LPVOID pvValue, LPVOID ulSize)');
# my $ret = $WebSocketGetGlobalProperty->Call($eType, $pvValue, $ulSize);
# eType : WEB_SOCKET_PROPERTY_TYPE -> int
# pvValue : void* in/out -> LPVOID
# ulSize : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型