ホーム › Networking.WinHttp › WinHttpWebSocketReceive
WinHttpWebSocketReceive
関数WebSocket接続からデータを受信する。
シグネチャ
// WINHTTP.dll
#include <windows.h>
DWORD WinHttpWebSocketReceive(
void* hWebSocket,
void* pvBuffer,
DWORD dwBufferLength,
DWORD* pdwBytesRead,
WINHTTP_WEB_SOCKET_BUFFER_TYPE* peBufferType
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hWebSocket | void* | in | 受信対象のWebSocketハンドル。 |
| pvBuffer | void* | out | 受信データを格納するバッファへのポインタ。出力用。 |
| dwBufferLength | DWORD | in | pvBufferが受け入れ可能な最大バイト数。 |
| pdwBytesRead | DWORD* | inout | 実際に受信したバイト数を受け取るDWORDポインタ。同期時に有効。 |
| peBufferType | WINHTTP_WEB_SOCKET_BUFFER_TYPE* | out | 受信データの種別を受け取る列挙値ポインタ。バイナリ/UTF8/断片を示す。 |
戻り値の型: 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), varptr(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, var ; 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 -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINHTTP.dll" #cfunc global WinHttpWebSocketReceive "WinHttpWebSocketReceive" sptr, sptr, int, sptr, sptr ; res = WinHttpWebSocketReceive(hWebSocket, pvBuffer, dwBufferLength, varptr(pdwBytesRead), varptr(peBufferType)) ; hWebSocket : void* -> "sptr" ; pvBuffer : void* out -> "sptr" ; dwBufferLength : DWORD -> "int" ; pdwBytesRead : DWORD* in/out -> "sptr" ; peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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, var ; 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 -> "var" ; ※出力/バッファ引数は 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, intptr, intptr ; res = WinHttpWebSocketReceive(hWebSocket, pvBuffer, dwBufferLength, varptr(pdwBytesRead), varptr(peBufferType)) ; hWebSocket : void* -> "intptr" ; pvBuffer : void* out -> "intptr" ; dwBufferLength : DWORD -> "int" ; pdwBytesRead : DWORD* in/out -> "intptr" ; peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 // DWORDfunction 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)。const std = @import("std");
extern "winhttp" fn WinHttpWebSocketReceive(
hWebSocket: ?*anyopaque, // void*
pvBuffer: ?*anyopaque, // void* out
dwBufferLength: u32, // DWORD
pdwBytesRead: [*c]u32, // DWORD* in/out
peBufferType: [*c]i32 // WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
) callconv(std.os.windows.WINAPI) u32;proc WinHttpWebSocketReceive(
hWebSocket: pointer, # void*
pvBuffer: pointer, # void* out
dwBufferLength: uint32, # DWORD
pdwBytesRead: ptr uint32, # DWORD* in/out
peBufferType: ptr int32 # WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
): uint32 {.importc: "WinHttpWebSocketReceive", stdcall, dynlib: "WINHTTP.dll".}pragma(lib, "winhttp");
extern(Windows)
uint WinHttpWebSocketReceive(
void* hWebSocket, // void*
void* pvBuffer, // void* out
uint dwBufferLength, // DWORD
uint* pdwBytesRead, // DWORD* in/out
int* peBufferType // WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
);ccall((:WinHttpWebSocketReceive, "WINHTTP.dll"), stdcall, UInt32,
(Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Ptr{UInt32}, Ptr{Int32}),
hWebSocket, pvBuffer, dwBufferLength, pdwBytesRead, peBufferType)
# hWebSocket : void* -> Ptr{Cvoid}
# pvBuffer : void* out -> Ptr{Cvoid}
# dwBufferLength : DWORD -> UInt32
# pdwBytesRead : DWORD* in/out -> Ptr{UInt32}
# peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t WinHttpWebSocketReceive(
void* hWebSocket,
void* pvBuffer,
uint32_t dwBufferLength,
uint32_t* pdwBytesRead,
int32_t* peBufferType);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpWebSocketReceive(hWebSocket, pvBuffer, dwBufferLength, pdwBytesRead, peBufferType)
-- hWebSocket : void*
-- pvBuffer : void* out
-- dwBufferLength : DWORD
-- pdwBytesRead : DWORD* in/out
-- peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpWebSocketReceive = lib.func('__stdcall', 'WinHttpWebSocketReceive', 'uint32_t', ['void *', 'void *', 'uint32_t', 'uint32_t *', 'int32_t *']);
// WinHttpWebSocketReceive(hWebSocket, pvBuffer, dwBufferLength, pdwBytesRead, peBufferType)
// hWebSocket : void* -> 'void *'
// pvBuffer : void* out -> 'void *'
// dwBufferLength : DWORD -> 'uint32_t'
// pdwBytesRead : DWORD* in/out -> 'uint32_t *'
// peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WINHTTP.dll", {
WinHttpWebSocketReceive: { parameters: ["pointer", "pointer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WinHttpWebSocketReceive(hWebSocket, pvBuffer, dwBufferLength, pdwBytesRead, peBufferType)
// hWebSocket : void* -> "pointer"
// pvBuffer : void* out -> "pointer"
// dwBufferLength : DWORD -> "u32"
// pdwBytesRead : DWORD* in/out -> "pointer"
// peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t WinHttpWebSocketReceive(
void* hWebSocket,
void* pvBuffer,
uint32_t dwBufferLength,
uint32_t* pdwBytesRead,
int32_t* peBufferType);
C, "WINHTTP.dll");
// $ffi->WinHttpWebSocketReceive(hWebSocket, pvBuffer, dwBufferLength, pdwBytesRead, peBufferType);
// hWebSocket : void*
// pvBuffer : void* out
// dwBufferLength : DWORD
// pdwBytesRead : DWORD* in/out
// peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Winhttp extends StdCallLibrary {
Winhttp INSTANCE = Native.load("winhttp", Winhttp.class);
int WinHttpWebSocketReceive(
Pointer hWebSocket, // void*
Pointer pvBuffer, // void* out
int dwBufferLength, // DWORD
IntByReference pdwBytesRead, // DWORD* in/out
IntByReference peBufferType // WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
);
}@[Link("winhttp")]
lib LibWINHTTP
fun WinHttpWebSocketReceive = WinHttpWebSocketReceive(
hWebSocket : Void*, # void*
pvBuffer : Void*, # void* out
dwBufferLength : UInt32, # DWORD
pdwBytesRead : UInt32*, # DWORD* in/out
peBufferType : Int32* # WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WinHttpWebSocketReceiveNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>, Pointer<Int32>);
typedef WinHttpWebSocketReceiveDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>, Pointer<Int32>);
final WinHttpWebSocketReceive = DynamicLibrary.open('WINHTTP.dll')
.lookupFunction<WinHttpWebSocketReceiveNative, WinHttpWebSocketReceiveDart>('WinHttpWebSocketReceive');
// hWebSocket : void* -> Pointer<Void>
// pvBuffer : void* out -> Pointer<Void>
// dwBufferLength : DWORD -> Uint32
// pdwBytesRead : DWORD* in/out -> Pointer<Uint32>
// peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
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';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WinHttpWebSocketReceive"
c_WinHttpWebSocketReceive :: Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> Ptr Int32 -> IO Word32
-- hWebSocket : void* -> Ptr ()
-- pvBuffer : void* out -> Ptr ()
-- dwBufferLength : DWORD -> Word32
-- pdwBytesRead : DWORD* in/out -> Ptr Word32
-- peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let winhttpwebsocketreceive =
foreign "WinHttpWebSocketReceive"
((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> (ptr int32_t) @-> returning uint32_t)
(* hWebSocket : void* -> (ptr void) *)
(* pvBuffer : void* out -> (ptr void) *)
(* dwBufferLength : DWORD -> uint32_t *)
(* pdwBytesRead : DWORD* in/out -> (ptr uint32_t) *)
(* peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)
(cffi:defcfun ("WinHttpWebSocketReceive" win-http-web-socket-receive :convention :stdcall) :uint32
(h-web-socket :pointer) ; void*
(pv-buffer :pointer) ; void* out
(dw-buffer-length :uint32) ; DWORD
(pdw-bytes-read :pointer) ; DWORD* in/out
(pe-buffer-type :pointer)) ; WINHTTP_WEB_SOCKET_BUFFER_TYPE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WinHttpWebSocketReceive = Win32::API::More->new('WINHTTP',
'DWORD WinHttpWebSocketReceive(LPVOID hWebSocket, LPVOID pvBuffer, DWORD dwBufferLength, LPVOID pdwBytesRead, LPVOID peBufferType)');
# my $ret = $WinHttpWebSocketReceive->Call($hWebSocket, $pvBuffer, $dwBufferLength, $pdwBytesRead, $peBufferType);
# hWebSocket : void* -> LPVOID
# pvBuffer : void* out -> LPVOID
# dwBufferLength : DWORD -> DWORD
# pdwBytesRead : DWORD* in/out -> LPVOID
# peBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。