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

WinHttpWebSocketReceive

関数
WebSocket接続からデータを受信する。
DLLWINHTTP.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD WinHttpWebSocketReceive(
    void* hWebSocket,
    void* pvBuffer,
    DWORD dwBufferLength,
    DWORD* pdwBytesRead,
    WINHTTP_WEB_SOCKET_BUFFER_TYPE* peBufferType
);

パラメーター

名前方向
hWebSocketvoid*in
pvBuffervoid*out
dwBufferLengthDWORDin
pdwBytesReadDWORD*inout
peBufferTypeWINHTTP_WEB_SOCKET_BUFFER_TYPE*out

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WinHttpWebSocketReceive(
    void* hWebSocket,
    void* pvBuffer,
    DWORD dwBufferLength,
    DWORD* pdwBytesRead,
    WINHTTP_WEB_SOCKET_BUFFER_TYPE* peBufferType
);
[DllImport("WINHTTP.dll", ExactSpelling = true)]
static extern uint WinHttpWebSocketReceive(
    IntPtr hWebSocket,   // void*
    IntPtr pvBuffer,   // void* out
    uint dwBufferLength,   // DWORD
    ref uint pdwBytesRead,   // DWORD* in/out
    out int peBufferType   // WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
);
<DllImport("WINHTTP.dll", ExactSpelling:=True)>
Public Shared Function WinHttpWebSocketReceive(
    hWebSocket As IntPtr,   ' void*
    pvBuffer As IntPtr,   ' void* out
    dwBufferLength As UInteger,   ' DWORD
    ByRef pdwBytesRead As UInteger,   ' DWORD* in/out
    <Out> ByRef peBufferType As Integer   ' WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
) As UInteger
End Function
' hWebSocket : void*
' pvBuffer : void* out
' dwBufferLength : DWORD
' pdwBytesRead : DWORD* in/out
' peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
Declare PtrSafe Function WinHttpWebSocketReceive Lib "winhttp" ( _
    ByVal hWebSocket As LongPtr, _
    ByVal pvBuffer As LongPtr, _
    ByVal dwBufferLength As Long, _
    ByRef pdwBytesRead As Long, _
    ByRef peBufferType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinHttpWebSocketReceive = ctypes.windll.winhttp.WinHttpWebSocketReceive
WinHttpWebSocketReceive.restype = wintypes.DWORD
WinHttpWebSocketReceive.argtypes = [
    ctypes.POINTER(None),  # hWebSocket : void*
    ctypes.POINTER(None),  # pvBuffer : void* out
    wintypes.DWORD,  # dwBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwBytesRead : DWORD* in/out
    ctypes.c_void_p,  # peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpWebSocketReceive = winhttp.NewProc("WinHttpWebSocketReceive")
)

// hWebSocket (void*), pvBuffer (void* out), dwBufferLength (DWORD), pdwBytesRead (DWORD* in/out), peBufferType (WINHTTP_WEB_SOCKET_BUFFER_TYPE* out)
r1, _, err := procWinHttpWebSocketReceive.Call(
	uintptr(hWebSocket),
	uintptr(pvBuffer),
	uintptr(dwBufferLength),
	uintptr(pdwBytesRead),
	uintptr(peBufferType),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WinHttpWebSocketReceive(
  hWebSocket: Pointer;   // void*
  pvBuffer: Pointer;   // void* out
  dwBufferLength: DWORD;   // DWORD
  pdwBytesRead: Pointer;   // DWORD* in/out
  peBufferType: Pointer   // WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
): DWORD; stdcall;
  external 'WINHTTP.dll' name 'WinHttpWebSocketReceive';
result := DllCall("WINHTTP\WinHttpWebSocketReceive"
    , "Ptr", hWebSocket   ; void*
    , "Ptr", pvBuffer   ; void* out
    , "UInt", dwBufferLength   ; DWORD
    , "Ptr", pdwBytesRead   ; DWORD* in/out
    , "Ptr", peBufferType   ; WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
    , "UInt")   ; return: DWORD
●WinHttpWebSocketReceive(hWebSocket, pvBuffer, dwBufferLength, pdwBytesRead, peBufferType) = DLL("WINHTTP.dll", "dword WinHttpWebSocketReceive(void*, void*, dword, void*, void*)")
# 呼び出し: WinHttpWebSocketReceive(hWebSocket, pvBuffer, dwBufferLength, pdwBytesRead, peBufferType)
# hWebSocket : void* -> "void*"
# pvBuffer : void* out -> "void*"
# dwBufferLength : DWORD -> "dword"
# pdwBytesRead : DWORD* in/out -> "void*"
# peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。