ホーム › Networking.WebSocket › WebSocketBeginClientHandshake
WebSocketBeginClientHandshake
関数WebSocketクライアントのハンドシェイクを開始する。
シグネチャ
// 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
);パラメーター
| 名前 | 型 | 方向 |
|---|---|---|
| hWebSocket | WEB_SOCKET_HANDLE | in |
| pszSubprotocols | LPCSTR* | inoptional |
| ulSubprotocolCount | DWORD | in |
| pszExtensions | LPCSTR* | inoptional |
| ulExtensionCount | DWORD | in |
| pInitialHeaders | WEB_SOCKET_HTTP_HEADER* | inoptional |
| ulInitialHeaderCount | DWORD | in |
| pAdditionalHeaders | WEB_SOCKET_HTTP_HEADER** | out |
| pulAdditionalHeaderCount | DWORD* | out |
戻り値の型: 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 方式にも切替可。#uselib "websocket.dll" #cfunc global WebSocketBeginClientHandshake "WebSocketBeginClientHandshake" sptr, sptr, int, sptr, int, sptr, int, sptr, sptr ; res = WebSocketBeginClientHandshake(hWebSocket, varptr(pszSubprotocols), ulSubprotocolCount, varptr(pszExtensions), ulExtensionCount, varptr(pInitialHeaders), ulInitialHeaderCount, varptr(pAdditionalHeaders), varptr(pulAdditionalHeaderCount)) ; hWebSocket : WEB_SOCKET_HANDLE -> "sptr" ; pszSubprotocols : LPCSTR* optional -> "sptr" ; ulSubprotocolCount : DWORD -> "int" ; pszExtensions : LPCSTR* optional -> "sptr" ; ulExtensionCount : DWORD -> "int" ; pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional -> "sptr" ; ulInitialHeaderCount : DWORD -> "int" ; pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out -> "sptr" ; pulAdditionalHeaderCount : DWORD* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; 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, intptr, int, intptr, int, intptr, int, intptr, intptr ; res = WebSocketBeginClientHandshake(hWebSocket, varptr(pszSubprotocols), ulSubprotocolCount, varptr(pszExtensions), ulExtensionCount, varptr(pInitialHeaders), ulInitialHeaderCount, varptr(pAdditionalHeaders), varptr(pulAdditionalHeaderCount)) ; hWebSocket : WEB_SOCKET_HANDLE -> "intptr" ; pszSubprotocols : LPCSTR* optional -> "intptr" ; ulSubprotocolCount : DWORD -> "int" ; pszExtensions : LPCSTR* optional -> "intptr" ; ulExtensionCount : DWORD -> "int" ; pInitialHeaders : WEB_SOCKET_HTTP_HEADER* optional -> "intptr" ; ulInitialHeaderCount : DWORD -> "int" ; pAdditionalHeaders : WEB_SOCKET_HTTP_HEADER** out -> "intptr" ; pulAdditionalHeaderCount : DWORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 // HRESULTfunction 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)。