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

HttpWebSocketReceive

関数
WebSocket接続でデータを受信する。
DLLWININET.dll呼出規約winapi

シグネチャ

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

BOOL HttpWebSocketReceive(
    void* hWebSocket,
    void* pvBuffer,
    DWORD dwBufferLength,
    DWORD* pdwBytesRead,
    HTTP_WEB_SOCKET_BUFFER_TYPE* pBufferType
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL HttpWebSocketReceive(
    void* hWebSocket,
    void* pvBuffer,
    DWORD dwBufferLength,
    DWORD* pdwBytesRead,
    HTTP_WEB_SOCKET_BUFFER_TYPE* pBufferType
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", ExactSpelling = true)]
static extern bool HttpWebSocketReceive(
    IntPtr hWebSocket,   // void*
    IntPtr pvBuffer,   // void* out
    uint dwBufferLength,   // DWORD
    ref uint pdwBytesRead,   // DWORD* in/out
    out int pBufferType   // HTTP_WEB_SOCKET_BUFFER_TYPE* out
);
<DllImport("WININET.dll", ExactSpelling:=True)>
Public Shared Function HttpWebSocketReceive(
    hWebSocket As IntPtr,   ' void*
    pvBuffer As IntPtr,   ' void* out
    dwBufferLength As UInteger,   ' DWORD
    ByRef pdwBytesRead As UInteger,   ' DWORD* in/out
    <Out> ByRef pBufferType As Integer   ' HTTP_WEB_SOCKET_BUFFER_TYPE* out
) As Boolean
End Function
' hWebSocket : void*
' pvBuffer : void* out
' dwBufferLength : DWORD
' pdwBytesRead : DWORD* in/out
' pBufferType : HTTP_WEB_SOCKET_BUFFER_TYPE* out
Declare PtrSafe Function HttpWebSocketReceive Lib "wininet" ( _
    ByVal hWebSocket As LongPtr, _
    ByVal pvBuffer As LongPtr, _
    ByVal dwBufferLength As Long, _
    ByRef pdwBytesRead As Long, _
    ByRef pBufferType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpWebSocketReceive = ctypes.windll.wininet.HttpWebSocketReceive
HttpWebSocketReceive.restype = wintypes.BOOL
HttpWebSocketReceive.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,  # pBufferType : HTTP_WEB_SOCKET_BUFFER_TYPE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procHttpWebSocketReceive = wininet.NewProc("HttpWebSocketReceive")
)

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