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

WebSocketReceive

関数
WebSocket経由でデータバッファを受信する。
DLLwebsocket.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT WebSocketReceive(
    WEB_SOCKET_HANDLE hWebSocket,
    WEB_SOCKET_BUFFER* pBuffer,   // optional
    void* pvContext   // optional
);

パラメーター

名前方向
hWebSocketWEB_SOCKET_HANDLEin
pBufferWEB_SOCKET_BUFFER*inoptional
pvContextvoid*inoptional

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WebSocketReceive(
    WEB_SOCKET_HANDLE hWebSocket,
    WEB_SOCKET_BUFFER* pBuffer,   // optional
    void* pvContext   // optional
);
[DllImport("websocket.dll", ExactSpelling = true)]
static extern int WebSocketReceive(
    IntPtr hWebSocket,   // WEB_SOCKET_HANDLE
    IntPtr pBuffer,   // WEB_SOCKET_BUFFER* optional
    IntPtr pvContext   // void* optional
);
<DllImport("websocket.dll", ExactSpelling:=True)>
Public Shared Function WebSocketReceive(
    hWebSocket As IntPtr,   ' WEB_SOCKET_HANDLE
    pBuffer As IntPtr,   ' WEB_SOCKET_BUFFER* optional
    pvContext As IntPtr   ' void* optional
) As Integer
End Function
' hWebSocket : WEB_SOCKET_HANDLE
' pBuffer : WEB_SOCKET_BUFFER* optional
' pvContext : void* optional
Declare PtrSafe Function WebSocketReceive Lib "websocket" ( _
    ByVal hWebSocket As LongPtr, _
    ByVal pBuffer As LongPtr, _
    ByVal pvContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WebSocketReceive = ctypes.windll.websocket.WebSocketReceive
WebSocketReceive.restype = ctypes.c_int
WebSocketReceive.argtypes = [
    wintypes.HANDLE,  # hWebSocket : WEB_SOCKET_HANDLE
    ctypes.c_void_p,  # pBuffer : WEB_SOCKET_BUFFER* optional
    ctypes.POINTER(None),  # pvContext : void* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	websocket = windows.NewLazySystemDLL("websocket.dll")
	procWebSocketReceive = websocket.NewProc("WebSocketReceive")
)

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