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