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

WebSocketCreateClientHandle

関数
クライアント用のWebSocketハンドルを作成する。
DLLwebsocket.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT WebSocketCreateClientHandle(
    const WEB_SOCKET_PROPERTY* pProperties,
    DWORD ulPropertyCount,
    WEB_SOCKET_HANDLE* phWebSocket
);

パラメーター

名前方向説明
pPropertiesWEB_SOCKET_PROPERTY*inWebSocket動作を構成するプロパティ配列。既定でよい場合はNULL可。
ulPropertyCountDWORDinpProperties配列の要素数。NULL時は0を指定する。
phWebSocketWEB_SOCKET_HANDLE*out生成されたクライアント側WebSocketハンドルを受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WebSocketCreateClientHandle(
    const WEB_SOCKET_PROPERTY* pProperties,
    DWORD ulPropertyCount,
    WEB_SOCKET_HANDLE* phWebSocket
);
[DllImport("websocket.dll", ExactSpelling = true)]
static extern int WebSocketCreateClientHandle(
    IntPtr pProperties,   // WEB_SOCKET_PROPERTY*
    uint ulPropertyCount,   // DWORD
    IntPtr phWebSocket   // WEB_SOCKET_HANDLE* out
);
<DllImport("websocket.dll", ExactSpelling:=True)>
Public Shared Function WebSocketCreateClientHandle(
    pProperties As IntPtr,   ' WEB_SOCKET_PROPERTY*
    ulPropertyCount As UInteger,   ' DWORD
    phWebSocket As IntPtr   ' WEB_SOCKET_HANDLE* out
) As Integer
End Function
' pProperties : WEB_SOCKET_PROPERTY*
' ulPropertyCount : DWORD
' phWebSocket : WEB_SOCKET_HANDLE* out
Declare PtrSafe Function WebSocketCreateClientHandle Lib "websocket" ( _
    ByVal pProperties As LongPtr, _
    ByVal ulPropertyCount As Long, _
    ByVal phWebSocket As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WebSocketCreateClientHandle = ctypes.windll.websocket.WebSocketCreateClientHandle
WebSocketCreateClientHandle.restype = ctypes.c_int
WebSocketCreateClientHandle.argtypes = [
    ctypes.c_void_p,  # pProperties : WEB_SOCKET_PROPERTY*
    wintypes.DWORD,  # ulPropertyCount : DWORD
    ctypes.c_void_p,  # phWebSocket : WEB_SOCKET_HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	websocket = windows.NewLazySystemDLL("websocket.dll")
	procWebSocketCreateClientHandle = websocket.NewProc("WebSocketCreateClientHandle")
)

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

extern "websocket" fn WebSocketCreateClientHandle(
    pProperties: [*c]WEB_SOCKET_PROPERTY, // WEB_SOCKET_PROPERTY*
    ulPropertyCount: u32, // DWORD
    phWebSocket: ?*anyopaque // WEB_SOCKET_HANDLE* out
) callconv(std.os.windows.WINAPI) i32;
proc WebSocketCreateClientHandle(
    pProperties: ptr WEB_SOCKET_PROPERTY,  # WEB_SOCKET_PROPERTY*
    ulPropertyCount: uint32,  # DWORD
    phWebSocket: pointer  # WEB_SOCKET_HANDLE* out
): int32 {.importc: "WebSocketCreateClientHandle", stdcall, dynlib: "websocket.dll".}
pragma(lib, "websocket");
extern(Windows)
int WebSocketCreateClientHandle(
    WEB_SOCKET_PROPERTY* pProperties,   // WEB_SOCKET_PROPERTY*
    uint ulPropertyCount,   // DWORD
    void* phWebSocket   // WEB_SOCKET_HANDLE* out
);
ccall((:WebSocketCreateClientHandle, "websocket.dll"), stdcall, Int32,
      (Ptr{WEB_SOCKET_PROPERTY}, UInt32, Ptr{Cvoid}),
      pProperties, ulPropertyCount, phWebSocket)
# pProperties : WEB_SOCKET_PROPERTY* -> Ptr{WEB_SOCKET_PROPERTY}
# ulPropertyCount : DWORD -> UInt32
# phWebSocket : WEB_SOCKET_HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WebSocketCreateClientHandle(
    void* pProperties,
    uint32_t ulPropertyCount,
    void* phWebSocket);
]]
local websocket = ffi.load("websocket")
-- websocket.WebSocketCreateClientHandle(pProperties, ulPropertyCount, phWebSocket)
-- pProperties : WEB_SOCKET_PROPERTY*
-- ulPropertyCount : DWORD
-- phWebSocket : WEB_SOCKET_HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('websocket.dll');
const WebSocketCreateClientHandle = lib.func('__stdcall', 'WebSocketCreateClientHandle', 'int32_t', ['void *', 'uint32_t', 'void *']);
// WebSocketCreateClientHandle(pProperties, ulPropertyCount, phWebSocket)
// pProperties : WEB_SOCKET_PROPERTY* -> 'void *'
// ulPropertyCount : DWORD -> 'uint32_t'
// phWebSocket : WEB_SOCKET_HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("websocket.dll", {
  WebSocketCreateClientHandle: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WebSocketCreateClientHandle(pProperties, ulPropertyCount, phWebSocket)
// pProperties : WEB_SOCKET_PROPERTY* -> "pointer"
// ulPropertyCount : DWORD -> "u32"
// phWebSocket : WEB_SOCKET_HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WebSocketCreateClientHandle(
    void* pProperties,
    uint32_t ulPropertyCount,
    void* phWebSocket);
C, "websocket.dll");
// $ffi->WebSocketCreateClientHandle(pProperties, ulPropertyCount, phWebSocket);
// pProperties : WEB_SOCKET_PROPERTY*
// ulPropertyCount : DWORD
// phWebSocket : WEB_SOCKET_HANDLE* 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 WebSocketCreateClientHandle(
        Pointer pProperties,   // WEB_SOCKET_PROPERTY*
        int ulPropertyCount,   // DWORD
        Pointer phWebSocket   // WEB_SOCKET_HANDLE* out
    );
}
@[Link("websocket")]
lib Libwebsocket
  fun WebSocketCreateClientHandle = WebSocketCreateClientHandle(
    pProperties : WEB_SOCKET_PROPERTY*,   # WEB_SOCKET_PROPERTY*
    ulPropertyCount : UInt32,   # DWORD
    phWebSocket : Void*   # WEB_SOCKET_HANDLE* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WebSocketCreateClientHandleNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>);
typedef WebSocketCreateClientHandleDart = int Function(Pointer<Void>, int, Pointer<Void>);
final WebSocketCreateClientHandle = DynamicLibrary.open('websocket.dll')
    .lookupFunction<WebSocketCreateClientHandleNative, WebSocketCreateClientHandleDart>('WebSocketCreateClientHandle');
// pProperties : WEB_SOCKET_PROPERTY* -> Pointer<Void>
// ulPropertyCount : DWORD -> Uint32
// phWebSocket : WEB_SOCKET_HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WebSocketCreateClientHandle(
  pProperties: Pointer;   // WEB_SOCKET_PROPERTY*
  ulPropertyCount: DWORD;   // DWORD
  phWebSocket: Pointer   // WEB_SOCKET_HANDLE* out
): Integer; stdcall;
  external 'websocket.dll' name 'WebSocketCreateClientHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WebSocketCreateClientHandle"
  c_WebSocketCreateClientHandle :: Ptr () -> Word32 -> Ptr () -> IO Int32
-- pProperties : WEB_SOCKET_PROPERTY* -> Ptr ()
-- ulPropertyCount : DWORD -> Word32
-- phWebSocket : WEB_SOCKET_HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let websocketcreateclienthandle =
  foreign "WebSocketCreateClientHandle"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* pProperties : WEB_SOCKET_PROPERTY* -> (ptr void) *)
(* ulPropertyCount : DWORD -> uint32_t *)
(* phWebSocket : WEB_SOCKET_HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library websocket (t "websocket.dll"))
(cffi:use-foreign-library websocket)

(cffi:defcfun ("WebSocketCreateClientHandle" web-socket-create-client-handle :convention :stdcall) :int32
  (p-properties :pointer)   ; WEB_SOCKET_PROPERTY*
  (ul-property-count :uint32)   ; DWORD
  (ph-web-socket :pointer))   ; WEB_SOCKET_HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WebSocketCreateClientHandle = Win32::API::More->new('websocket',
    'int WebSocketCreateClientHandle(LPVOID pProperties, DWORD ulPropertyCount, HANDLE phWebSocket)');
# my $ret = $WebSocketCreateClientHandle->Call($pProperties, $ulPropertyCount, $phWebSocket);
# pProperties : WEB_SOCKET_PROPERTY* -> LPVOID
# ulPropertyCount : DWORD -> DWORD
# phWebSocket : WEB_SOCKET_HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型