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

WinHttpWebSocketSend

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

シグネチャ

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

DWORD WinHttpWebSocketSend(
    void* hWebSocket,
    WINHTTP_WEB_SOCKET_BUFFER_TYPE eBufferType,
    void* pvBuffer,   // optional
    DWORD dwBufferLength
);

パラメーター

名前方向説明
hWebSocketvoid*inwebsocket へのハンドル。
eBufferTypeWINHTTP_WEB_SOCKET_BUFFER_TYPEin

バッファの種類。

注意 WINHTTP_WEB_SOCKET_CLOSE_BUFFER_TYPE は指定しないでください。接続を閉じるには WinHttpWebSocketClose または WinHttpWebSocketShutdown を使用してください。

pvBuffervoid*inoptional送信するデータを含むバッファへのポインター。dwBufferLength が 0 の場合に限り NULL を指定できます。
dwBufferLengthDWORDinpvBuffer の長さ。

戻り値の型: DWORD

公式ドキュメント

WebSocket 接続を介してデータを送信します。

戻り値

型: DWORD

成功した場合は NO_ERROR。それ以外の場合はエラーコード。

説明
ERROR_INVALID_OPERATION
クローズまたは送信が保留中であるか、送信チャネルが既に閉じられています。
ERROR_INVALID_PARAMETER
パラメーターが無効です。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

WinHttpWebSocketSend = ctypes.windll.winhttp.WinHttpWebSocketSend
WinHttpWebSocketSend.restype = wintypes.DWORD
WinHttpWebSocketSend.argtypes = [
    ctypes.POINTER(None),  # hWebSocket : void*
    ctypes.c_int,  # eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE
    ctypes.POINTER(None),  # pvBuffer : void* optional
    wintypes.DWORD,  # dwBufferLength : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpWebSocketSend = Fiddle::Function.new(
  lib['WinHttpWebSocketSend'],
  [
    Fiddle::TYPE_VOIDP,  # hWebSocket : void*
    Fiddle::TYPE_INT,  # eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE
    Fiddle::TYPE_VOIDP,  # pvBuffer : void* optional
    -Fiddle::TYPE_INT,  # dwBufferLength : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winhttp")]
extern "system" {
    fn WinHttpWebSocketSend(
        hWebSocket: *mut (),  // void*
        eBufferType: i32,  // WINHTTP_WEB_SOCKET_BUFFER_TYPE
        pvBuffer: *mut (),  // void* optional
        dwBufferLength: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINHTTP.dll")]
public static extern uint WinHttpWebSocketSend(IntPtr hWebSocket, int eBufferType, IntPtr pvBuffer, uint dwBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpWebSocketSend' -Namespace Win32 -PassThru
# $api::WinHttpWebSocketSend(hWebSocket, eBufferType, pvBuffer, dwBufferLength)
#uselib "WINHTTP.dll"
#func global WinHttpWebSocketSend "WinHttpWebSocketSend" sptr, sptr, sptr, sptr
; WinHttpWebSocketSend hWebSocket, eBufferType, pvBuffer, dwBufferLength   ; 戻り値は stat
; hWebSocket : void* -> "sptr"
; eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> "sptr"
; pvBuffer : void* optional -> "sptr"
; dwBufferLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINHTTP.dll"
#cfunc global WinHttpWebSocketSend "WinHttpWebSocketSend" sptr, int, sptr, int
; res = WinHttpWebSocketSend(hWebSocket, eBufferType, pvBuffer, dwBufferLength)
; hWebSocket : void* -> "sptr"
; eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> "int"
; pvBuffer : void* optional -> "sptr"
; dwBufferLength : DWORD -> "int"
; DWORD WinHttpWebSocketSend(void* hWebSocket, WINHTTP_WEB_SOCKET_BUFFER_TYPE eBufferType, void* pvBuffer, DWORD dwBufferLength)
#uselib "WINHTTP.dll"
#cfunc global WinHttpWebSocketSend "WinHttpWebSocketSend" intptr, int, intptr, int
; res = WinHttpWebSocketSend(hWebSocket, eBufferType, pvBuffer, dwBufferLength)
; hWebSocket : void* -> "intptr"
; eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> "int"
; pvBuffer : void* optional -> "intptr"
; dwBufferLength : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpWebSocketSend = winhttp.NewProc("WinHttpWebSocketSend")
)

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

extern "winhttp" fn WinHttpWebSocketSend(
    hWebSocket: ?*anyopaque, // void*
    eBufferType: i32, // WINHTTP_WEB_SOCKET_BUFFER_TYPE
    pvBuffer: ?*anyopaque, // void* optional
    dwBufferLength: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc WinHttpWebSocketSend(
    hWebSocket: pointer,  # void*
    eBufferType: int32,  # WINHTTP_WEB_SOCKET_BUFFER_TYPE
    pvBuffer: pointer,  # void* optional
    dwBufferLength: uint32  # DWORD
): uint32 {.importc: "WinHttpWebSocketSend", stdcall, dynlib: "WINHTTP.dll".}
pragma(lib, "winhttp");
extern(Windows)
uint WinHttpWebSocketSend(
    void* hWebSocket,   // void*
    int eBufferType,   // WINHTTP_WEB_SOCKET_BUFFER_TYPE
    void* pvBuffer,   // void* optional
    uint dwBufferLength   // DWORD
);
ccall((:WinHttpWebSocketSend, "WINHTTP.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, UInt32),
      hWebSocket, eBufferType, pvBuffer, dwBufferLength)
# hWebSocket : void* -> Ptr{Cvoid}
# eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> Int32
# pvBuffer : void* optional -> Ptr{Cvoid}
# dwBufferLength : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WinHttpWebSocketSend(
    void* hWebSocket,
    int32_t eBufferType,
    void* pvBuffer,
    uint32_t dwBufferLength);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpWebSocketSend(hWebSocket, eBufferType, pvBuffer, dwBufferLength)
-- hWebSocket : void*
-- eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE
-- pvBuffer : void* optional
-- dwBufferLength : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpWebSocketSend = lib.func('__stdcall', 'WinHttpWebSocketSend', 'uint32_t', ['void *', 'int32_t', 'void *', 'uint32_t']);
// WinHttpWebSocketSend(hWebSocket, eBufferType, pvBuffer, dwBufferLength)
// hWebSocket : void* -> 'void *'
// eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> 'int32_t'
// pvBuffer : void* optional -> 'void *'
// dwBufferLength : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINHTTP.dll", {
  WinHttpWebSocketSend: { parameters: ["pointer", "i32", "pointer", "u32"], result: "u32" },
});
// lib.symbols.WinHttpWebSocketSend(hWebSocket, eBufferType, pvBuffer, dwBufferLength)
// hWebSocket : void* -> "pointer"
// eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> "i32"
// pvBuffer : void* optional -> "pointer"
// dwBufferLength : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WinHttpWebSocketSend(
    void* hWebSocket,
    int32_t eBufferType,
    void* pvBuffer,
    uint32_t dwBufferLength);
C, "WINHTTP.dll");
// $ffi->WinHttpWebSocketSend(hWebSocket, eBufferType, pvBuffer, dwBufferLength);
// hWebSocket : void*
// eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE
// pvBuffer : void* optional
// dwBufferLength : DWORD
// 構造体/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 WinHttpWebSocketSend(
        Pointer hWebSocket,   // void*
        int eBufferType,   // WINHTTP_WEB_SOCKET_BUFFER_TYPE
        Pointer pvBuffer,   // void* optional
        int dwBufferLength   // DWORD
    );
}
@[Link("winhttp")]
lib LibWINHTTP
  fun WinHttpWebSocketSend = WinHttpWebSocketSend(
    hWebSocket : Void*,   # void*
    eBufferType : Int32,   # WINHTTP_WEB_SOCKET_BUFFER_TYPE
    pvBuffer : Void*,   # void* optional
    dwBufferLength : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinHttpWebSocketSendNative = Uint32 Function(Pointer<Void>, Int32, Pointer<Void>, Uint32);
typedef WinHttpWebSocketSendDart = int Function(Pointer<Void>, int, Pointer<Void>, int);
final WinHttpWebSocketSend = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpWebSocketSendNative, WinHttpWebSocketSendDart>('WinHttpWebSocketSend');
// hWebSocket : void* -> Pointer<Void>
// eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> Int32
// pvBuffer : void* optional -> Pointer<Void>
// dwBufferLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpWebSocketSend(
  hWebSocket: Pointer;   // void*
  eBufferType: Integer;   // WINHTTP_WEB_SOCKET_BUFFER_TYPE
  pvBuffer: Pointer;   // void* optional
  dwBufferLength: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINHTTP.dll' name 'WinHttpWebSocketSend';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpWebSocketSend"
  c_WinHttpWebSocketSend :: Ptr () -> Int32 -> Ptr () -> Word32 -> IO Word32
-- hWebSocket : void* -> Ptr ()
-- eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> Int32
-- pvBuffer : void* optional -> Ptr ()
-- dwBufferLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpwebsocketsend =
  foreign "WinHttpWebSocketSend"
    ((ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* hWebSocket : void* -> (ptr void) *)
(* eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> int32_t *)
(* pvBuffer : void* optional -> (ptr void) *)
(* dwBufferLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)

(cffi:defcfun ("WinHttpWebSocketSend" win-http-web-socket-send :convention :stdcall) :uint32
  (h-web-socket :pointer)   ; void*
  (e-buffer-type :int32)   ; WINHTTP_WEB_SOCKET_BUFFER_TYPE
  (pv-buffer :pointer)   ; void* optional
  (dw-buffer-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinHttpWebSocketSend = Win32::API::More->new('WINHTTP',
    'DWORD WinHttpWebSocketSend(LPVOID hWebSocket, int eBufferType, LPVOID pvBuffer, DWORD dwBufferLength)');
# my $ret = $WinHttpWebSocketSend->Call($hWebSocket, $eBufferType, $pvBuffer, $dwBufferLength);
# hWebSocket : void* -> LPVOID
# eBufferType : WINHTTP_WEB_SOCKET_BUFFER_TYPE -> int
# pvBuffer : void* optional -> LPVOID
# dwBufferLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型