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

WebSocketEndClientHandshake

関数
WebSocketクライアントのハンドシェイクを完了する。
DLLwebsocket.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT WebSocketEndClientHandshake(
    WEB_SOCKET_HANDLE hWebSocket,
    const WEB_SOCKET_HTTP_HEADER* pResponseHeaders,
    DWORD ulReponseHeaderCount,
    DWORD* pulSelectedExtensions,   // optional
    DWORD* pulSelectedExtensionCount,   // optional
    DWORD* pulSelectedSubprotocol   // optional
);

パラメーター

名前方向
hWebSocketWEB_SOCKET_HANDLEin
pResponseHeadersWEB_SOCKET_HTTP_HEADER*in
ulReponseHeaderCountDWORDin
pulSelectedExtensionsDWORD*inoutoptional
pulSelectedExtensionCountDWORD*inoutoptional
pulSelectedSubprotocolDWORD*inoutoptional

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

WebSocketEndClientHandshake = ctypes.windll.websocket.WebSocketEndClientHandshake
WebSocketEndClientHandshake.restype = ctypes.c_int
WebSocketEndClientHandshake.argtypes = [
    wintypes.HANDLE,  # hWebSocket : WEB_SOCKET_HANDLE
    ctypes.c_void_p,  # pResponseHeaders : WEB_SOCKET_HTTP_HEADER*
    wintypes.DWORD,  # ulReponseHeaderCount : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pulSelectedExtensions : DWORD* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # pulSelectedExtensionCount : DWORD* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # pulSelectedSubprotocol : DWORD* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	websocket = windows.NewLazySystemDLL("websocket.dll")
	procWebSocketEndClientHandshake = websocket.NewProc("WebSocketEndClientHandshake")
)

// hWebSocket (WEB_SOCKET_HANDLE), pResponseHeaders (WEB_SOCKET_HTTP_HEADER*), ulReponseHeaderCount (DWORD), pulSelectedExtensions (DWORD* optional, in/out), pulSelectedExtensionCount (DWORD* optional, in/out), pulSelectedSubprotocol (DWORD* optional, in/out)
r1, _, err := procWebSocketEndClientHandshake.Call(
	uintptr(hWebSocket),
	uintptr(pResponseHeaders),
	uintptr(ulReponseHeaderCount),
	uintptr(pulSelectedExtensions),
	uintptr(pulSelectedExtensionCount),
	uintptr(pulSelectedSubprotocol),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WebSocketEndClientHandshake(
  hWebSocket: THandle;   // WEB_SOCKET_HANDLE
  pResponseHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER*
  ulReponseHeaderCount: DWORD;   // DWORD
  pulSelectedExtensions: Pointer;   // DWORD* optional, in/out
  pulSelectedExtensionCount: Pointer;   // DWORD* optional, in/out
  pulSelectedSubprotocol: Pointer   // DWORD* optional, in/out
): Integer; stdcall;
  external 'websocket.dll' name 'WebSocketEndClientHandshake';
result := DllCall("websocket\WebSocketEndClientHandshake"
    , "Ptr", hWebSocket   ; WEB_SOCKET_HANDLE
    , "Ptr", pResponseHeaders   ; WEB_SOCKET_HTTP_HEADER*
    , "UInt", ulReponseHeaderCount   ; DWORD
    , "Ptr", pulSelectedExtensions   ; DWORD* optional, in/out
    , "Ptr", pulSelectedExtensionCount   ; DWORD* optional, in/out
    , "Ptr", pulSelectedSubprotocol   ; DWORD* optional, in/out
    , "Int")   ; return: HRESULT
●WebSocketEndClientHandshake(hWebSocket, pResponseHeaders, ulReponseHeaderCount, pulSelectedExtensions, pulSelectedExtensionCount, pulSelectedSubprotocol) = DLL("websocket.dll", "int WebSocketEndClientHandshake(void*, void*, dword, void*, void*, void*)")
# 呼び出し: WebSocketEndClientHandshake(hWebSocket, pResponseHeaders, ulReponseHeaderCount, pulSelectedExtensions, pulSelectedExtensionCount, pulSelectedSubprotocol)
# hWebSocket : WEB_SOCKET_HANDLE -> "void*"
# pResponseHeaders : WEB_SOCKET_HTTP_HEADER* -> "void*"
# ulReponseHeaderCount : DWORD -> "dword"
# pulSelectedExtensions : DWORD* optional, in/out -> "void*"
# pulSelectedExtensionCount : DWORD* optional, in/out -> "void*"
# pulSelectedSubprotocol : DWORD* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。