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

WebSocketBeginClientHandshake

関数
WebSocketクライアントのハンドシェイクを開始する。
DLLwebsocket.dll呼出規約winapi対応OSwindows8.0
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT WebSocketBeginClientHandshake(
    WEB_SOCKET_HANDLE hWebSocket,
    LPCSTR* pszSubprotocols,   // optional
    DWORD ulSubprotocolCount,
    LPCSTR* pszExtensions,   // optional
    DWORD ulExtensionCount,
    const WEB_SOCKET_HTTP_HEADER* pInitialHeaders,   // optional
    DWORD ulInitialHeaderCount,
    WEB_SOCKET_HTTP_HEADER** pAdditionalHeaders,
    DWORD* pulAdditionalHeaderCount
);

パラメーター

名前型方向説明
hWebSocketWEB_SOCKET_HANDLEin対象のWebSocketセッションハンドル。
pszSubprotocolsLPCSTR*inoptional要求するサブプロトコル名の文字列配列。不要ならNULL可。
ulSubprotocolCountDWORDinpszSubprotocols配列の要素数。
pszExtensionsLPCSTR*inoptional要求する拡張名の文字列配列。不要ならNULL可。
ulExtensionCountDWORDinpszExtensions配列の要素数。
pInitialHeadersWEB_SOCKET_HTTP_HEADER*inoptionalハンドシェイク要求に含める初期HTTPヘッダー配列。NULL可。
ulInitialHeaderCountDWORDinpInitialHeaders配列の要素数。
pAdditionalHeadersWEB_SOCKET_HTTP_HEADER**outWebSocketが生成した追加送信ヘッダー配列を受け取る出力ポインタ。
pulAdditionalHeaderCountDWORD*outpAdditionalHeaders配列の要素数を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WebSocketBeginClientHandshake(
    WEB_SOCKET_HANDLE hWebSocket,
    LPCSTR* pszSubprotocols,   // optional
    DWORD ulSubprotocolCount,
    LPCSTR* pszExtensions,   // optional
    DWORD ulExtensionCount,
    const WEB_SOCKET_HTTP_HEADER* pInitialHeaders,   // optional
    DWORD ulInitialHeaderCount,
    WEB_SOCKET_HTTP_HEADER** pAdditionalHeaders,
    DWORD* pulAdditionalHeaderCount
);
[DllImport("websocket.dll", ExactSpelling = true)]
static extern int WebSocketBeginClientHandshake(
    IntPtr hWebSocket,   // WEB_SOCKET_HANDLE
    IntPtr pszSubprotocols,   // LPCSTR* optional
    uint ulSubprotocolCount,   // DWORD
    IntPtr pszExtensions,   // LPCSTR* optional
    uint ulExtensionCount,   // DWORD
    IntPtr pInitialHeaders,   // WEB_SOCKET_HTTP_HEADER* optional
    uint ulInitialHeaderCount,   // DWORD
    IntPtr pAdditionalHeaders,   // WEB_SOCKET_HTTP_HEADER** out
    out uint pulAdditionalHeaderCount   // DWORD* out
);
<DllImport("websocket.dll", ExactSpelling:=True)>
Public Shared Function WebSocketBeginClientHandshake(
    hWebSocket As IntPtr,   ' WEB_SOCKET_HANDLE
    pszSubprotocols As IntPtr,   ' LPCSTR* optional
    ulSubprotocolCount As UInteger,   ' DWORD
    pszExtensions As IntPtr,   ' LPCSTR* optional
    ulExtensionCount As UInteger,   ' DWORD
    pInitialHeaders As IntPtr,   ' WEB_SOCKET_HTTP_HEADER* optional
    ulInitialHeaderCount As UInteger,   ' DWORD
    pAdditionalHeaders As IntPtr,   ' WEB_SOCKET_HTTP_HEADER** out
    <Out> ByRef pulAdditionalHeaderCount As UInteger   ' DWORD* out
) As Integer
End Function
' hWebSocket : WEB_SOCKET_HANDLE
' pszSubprotocols : LPCSTR* optional
' ulSubprotocolCount : DWORD
' pszExtensions : LPCSTR* optional
' ulExtensionCount : DWORD
' pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional
' ulInitialHeaderCount : DWORD
' pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out
' pulAdditionalHeaderCount : DWORD* out
Declare PtrSafe Function WebSocketBeginClientHandshake Lib "websocket" ( _
    ByVal hWebSocket As LongPtr, _
    ByVal pszSubprotocols As LongPtr, _
    ByVal ulSubprotocolCount As Long, _
    ByVal pszExtensions As LongPtr, _
    ByVal ulExtensionCount As Long, _
    ByVal pInitialHeaders As LongPtr, _
    ByVal ulInitialHeaderCount As Long, _
    ByVal pAdditionalHeaders As LongPtr, _
    ByRef pulAdditionalHeaderCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WebSocketBeginClientHandshake = ctypes.windll.websocket.WebSocketBeginClientHandshake
WebSocketBeginClientHandshake.restype = ctypes.c_int
WebSocketBeginClientHandshake.argtypes = [
    wintypes.HANDLE,  # hWebSocket : WEB_SOCKET_HANDLE
    ctypes.c_void_p,  # pszSubprotocols : LPCSTR* optional
    wintypes.DWORD,  # ulSubprotocolCount : DWORD
    ctypes.c_void_p,  # pszExtensions : LPCSTR* optional
    wintypes.DWORD,  # ulExtensionCount : DWORD
    ctypes.c_void_p,  # pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional
    wintypes.DWORD,  # ulInitialHeaderCount : DWORD
    ctypes.c_void_p,  # pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out
    ctypes.POINTER(wintypes.DWORD),  # pulAdditionalHeaderCount : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	websocket = windows.NewLazySystemDLL("websocket.dll")
	procWebSocketBeginClientHandshake = websocket.NewProc("WebSocketBeginClientHandshake")
)

// hWebSocket (WEB_SOCKET_HANDLE), pszSubprotocols (LPCSTR* optional), ulSubprotocolCount (DWORD), pszExtensions (LPCSTR* optional), ulExtensionCount (DWORD), pInitialHeaders (WEB_SOCKET_HTTP_HEADER* optional), ulInitialHeaderCount (DWORD), pAdditionalHeaders (WEB_SOCKET_HTTP_HEADER** out), pulAdditionalHeaderCount (DWORD* out)
r1, _, err := procWebSocketBeginClientHandshake.Call(
	uintptr(hWebSocket),
	uintptr(pszSubprotocols),
	uintptr(ulSubprotocolCount),
	uintptr(pszExtensions),
	uintptr(ulExtensionCount),
	uintptr(pInitialHeaders),
	uintptr(ulInitialHeaderCount),
	uintptr(pAdditionalHeaders),
	uintptr(pulAdditionalHeaderCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WebSocketBeginClientHandshake(
  hWebSocket: THandle;   // WEB_SOCKET_HANDLE
  pszSubprotocols: PPAnsiChar;   // LPCSTR* optional
  ulSubprotocolCount: DWORD;   // DWORD
  pszExtensions: PPAnsiChar;   // LPCSTR* optional
  ulExtensionCount: DWORD;   // DWORD
  pInitialHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER* optional
  ulInitialHeaderCount: DWORD;   // DWORD
  pAdditionalHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER** out
  pulAdditionalHeaderCount: Pointer   // DWORD* out
): Integer; stdcall;
  external 'websocket.dll' name 'WebSocketBeginClientHandshake';
result := DllCall("websocket\WebSocketBeginClientHandshake"
    , "Ptr", hWebSocket   ; WEB_SOCKET_HANDLE
    , "Ptr", pszSubprotocols   ; LPCSTR* optional
    , "UInt", ulSubprotocolCount   ; DWORD
    , "Ptr", pszExtensions   ; LPCSTR* optional
    , "UInt", ulExtensionCount   ; DWORD
    , "Ptr", pInitialHeaders   ; WEB_SOCKET_HTTP_HEADER* optional
    , "UInt", ulInitialHeaderCount   ; DWORD
    , "Ptr", pAdditionalHeaders   ; WEB_SOCKET_HTTP_HEADER** out
    , "Ptr", pulAdditionalHeaderCount   ; DWORD* out
    , "Int")   ; return: HRESULT
●WebSocketBeginClientHandshake(hWebSocket, pszSubprotocols, ulSubprotocolCount, pszExtensions, ulExtensionCount, pInitialHeaders, ulInitialHeaderCount, pAdditionalHeaders, pulAdditionalHeaderCount) = DLL("websocket.dll", "int WebSocketBeginClientHandshake(void*, void*, dword, void*, dword, void*, dword, void*, void*)")
# 呼び出し: WebSocketBeginClientHandshake(hWebSocket, pszSubprotocols, ulSubprotocolCount, pszExtensions, ulExtensionCount, pInitialHeaders, ulInitialHeaderCount, pAdditionalHeaders, pulAdditionalHeaderCount)
# hWebSocket : WEB_SOCKET_HANDLE -> "void*"
# pszSubprotocols : LPCSTR* optional -> "void*"
# ulSubprotocolCount : DWORD -> "dword"
# pszExtensions : LPCSTR* optional -> "void*"
# ulExtensionCount : DWORD -> "dword"
# pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional -> "void*"
# ulInitialHeaderCount : DWORD -> "dword"
# pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out -> "void*"
# pulAdditionalHeaderCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WebSocketBeginClientHandshakeNative = Int32 Function(Pointer<Void>, Pointer<Pointer<Utf8>>, Uint32, Pointer<Pointer<Utf8>>, Uint32, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef WebSocketBeginClientHandshakeDart = int Function(Pointer<Void>, Pointer<Pointer<Utf8>>, int, Pointer<Pointer<Utf8>>, int, Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>);
final WebSocketBeginClientHandshake = DynamicLibrary.open('websocket.dll')
    .lookupFunction<WebSocketBeginClientHandshakeNative, WebSocketBeginClientHandshakeDart>('WebSocketBeginClientHandshake');
// hWebSocket : WEB_SOCKET_HANDLE -> Pointer<Void>
// pszSubprotocols : LPCSTR* optional -> Pointer<Pointer<Utf8>>
// ulSubprotocolCount : DWORD -> Uint32
// pszExtensions : LPCSTR* optional -> Pointer<Pointer<Utf8>>
// ulExtensionCount : DWORD -> Uint32
// pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional -> Pointer<Void>
// ulInitialHeaderCount : DWORD -> Uint32
// pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out -> Pointer<Void>
// pulAdditionalHeaderCount : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WebSocketBeginClientHandshake(
  hWebSocket: THandle;   // WEB_SOCKET_HANDLE
  pszSubprotocols: PPAnsiChar;   // LPCSTR* optional
  ulSubprotocolCount: DWORD;   // DWORD
  pszExtensions: PPAnsiChar;   // LPCSTR* optional
  ulExtensionCount: DWORD;   // DWORD
  pInitialHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER* optional
  ulInitialHeaderCount: DWORD;   // DWORD
  pAdditionalHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER** out
  pulAdditionalHeaderCount: Pointer   // DWORD* out
): Integer; stdcall;
  external 'websocket.dll' name 'WebSocketBeginClientHandshake';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WebSocketBeginClientHandshake"
  c_WebSocketBeginClientHandshake :: Ptr () -> Ptr CString -> Word32 -> Ptr CString -> Word32 -> Ptr () -> Word32 -> Ptr () -> Ptr Word32 -> IO Int32
-- hWebSocket : WEB_SOCKET_HANDLE -> Ptr ()
-- pszSubprotocols : LPCSTR* optional -> Ptr CString
-- ulSubprotocolCount : DWORD -> Word32
-- pszExtensions : LPCSTR* optional -> Ptr CString
-- ulExtensionCount : DWORD -> Word32
-- pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional -> Ptr ()
-- ulInitialHeaderCount : DWORD -> Word32
-- pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out -> Ptr ()
-- pulAdditionalHeaderCount : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let websocketbeginclienthandshake =
  foreign "WebSocketBeginClientHandshake"
    ((ptr void) @-> (ptr string) @-> uint32_t @-> (ptr string) @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hWebSocket : WEB_SOCKET_HANDLE -> (ptr void) *)
(* pszSubprotocols : LPCSTR* optional -> (ptr string) *)
(* ulSubprotocolCount : DWORD -> uint32_t *)
(* pszExtensions : LPCSTR* optional -> (ptr string) *)
(* ulExtensionCount : DWORD -> uint32_t *)
(* pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional -> (ptr void) *)
(* ulInitialHeaderCount : DWORD -> uint32_t *)
(* pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out -> (ptr void) *)
(* pulAdditionalHeaderCount : DWORD* 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 ("WebSocketBeginClientHandshake" web-socket-begin-client-handshake :convention :stdcall) :int32
  (h-web-socket :pointer)   ; WEB_SOCKET_HANDLE
  (psz-subprotocols :pointer)   ; LPCSTR* optional
  (ul-subprotocol-count :uint32)   ; DWORD
  (psz-extensions :pointer)   ; LPCSTR* optional
  (ul-extension-count :uint32)   ; DWORD
  (p-initial-headers :pointer)   ; WEB_SOCKET_HTTP_HEADER* optional
  (ul-initial-header-count :uint32)   ; DWORD
  (p-additional-headers :pointer)   ; WEB_SOCKET_HTTP_HEADER** out
  (pul-additional-header-count :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WebSocketBeginClientHandshake = Win32::API::More->new('websocket',
    'int WebSocketBeginClientHandshake(HANDLE hWebSocket, LPVOID pszSubprotocols, DWORD ulSubprotocolCount, LPVOID pszExtensions, DWORD ulExtensionCount, LPVOID pInitialHeaders, DWORD ulInitialHeaderCount, LPVOID pAdditionalHeaders, LPVOID pulAdditionalHeaderCount)');
# my $ret = $WebSocketBeginClientHandshake->Call($hWebSocket, $pszSubprotocols, $ulSubprotocolCount, $pszExtensions, $ulExtensionCount, $pInitialHeaders, $ulInitialHeaderCount, $pAdditionalHeaders, $pulAdditionalHeaderCount);
# hWebSocket : WEB_SOCKET_HANDLE -> HANDLE
# pszSubprotocols : LPCSTR* optional -> LPVOID
# ulSubprotocolCount : DWORD -> DWORD
# pszExtensions : LPCSTR* optional -> LPVOID
# ulExtensionCount : DWORD -> DWORD
# pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional -> LPVOID
# ulInitialHeaderCount : DWORD -> DWORD
# pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out -> LPVOID
# pulAdditionalHeaderCount : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型