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*in
ulPropertyCountDWORDin
phWebSocketWEB_SOCKET_HANDLE*out

戻り値の型: 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)。