ホーム › Networking.WinHttp › WinHttpWebSocketCompleteUpgrade
WinHttpWebSocketCompleteUpgrade
関数HTTP要求からWebSocket接続への昇格を完了する。
シグネチャ
// WINHTTP.dll
#include <windows.h>
void* WinHttpWebSocketCompleteUpgrade(
void* hRequest,
UINT_PTR pContext // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hRequest | void* | in | WebSocket ハンドシェイクの送信に使用される HTTP リクエストハンドル。 |
| pContext | UINT_PTR | inoptional | 新しいハンドルに関連付けるコンテキスト。 |
戻り値の型: void*
公式ドキュメント
WinHttpSendRequest によって開始された WebSocket ハンドシェイクを完了します。
戻り値
型: HINTERNET
新しい WebSocket ハンドル。NULL の場合は、GetLastError を呼び出して失敗の原因を特定してください。
解説(Remarks)
WinHttpWebSocketCompleteUpgrade は、開いている HTTP リクエストに対して呼び出すことができ、他の WebSocket 操作を実行するための WebSocket ハンドルを取得します。
リクエストを送信する前に、WinHttpSetOption を WINHTTP_OPTION_UPGRADE_TO_WEB_SOCKET とともに呼び出して、リクエストハンドルを WebSocket アップグレードとしてマークしておく必要があります。
呼び出し元は、サーバーから返された HTTP ステータスコードを確認し、ステータスコードが 101 であった場合にのみこの関数を呼び出してください。それ以外のステータスコードで呼び出すと失敗します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WINHTTP.dll
#include <windows.h>
void* WinHttpWebSocketCompleteUpgrade(
void* hRequest,
UINT_PTR pContext // optional
);[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr WinHttpWebSocketCompleteUpgrade(
IntPtr hRequest, // void*
UIntPtr pContext // UINT_PTR optional
);<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpWebSocketCompleteUpgrade(
hRequest As IntPtr, ' void*
pContext As UIntPtr ' UINT_PTR optional
) As IntPtr
End Function' hRequest : void*
' pContext : UINT_PTR optional
Declare PtrSafe Function WinHttpWebSocketCompleteUpgrade Lib "winhttp" ( _
ByVal hRequest As LongPtr, _
ByVal pContext As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WinHttpWebSocketCompleteUpgrade = ctypes.windll.winhttp.WinHttpWebSocketCompleteUpgrade
WinHttpWebSocketCompleteUpgrade.restype = ctypes.c_void_p
WinHttpWebSocketCompleteUpgrade.argtypes = [
ctypes.POINTER(None), # hRequest : void*
ctypes.c_size_t, # pContext : UINT_PTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpWebSocketCompleteUpgrade = Fiddle::Function.new(
lib['WinHttpWebSocketCompleteUpgrade'],
[
Fiddle::TYPE_VOIDP, # hRequest : void*
Fiddle::TYPE_UINTPTR_T, # pContext : UINT_PTR optional
],
Fiddle::TYPE_VOIDP)#[link(name = "winhttp")]
extern "system" {
fn WinHttpWebSocketCompleteUpgrade(
hRequest: *mut (), // void*
pContext: usize // UINT_PTR optional
) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern IntPtr WinHttpWebSocketCompleteUpgrade(IntPtr hRequest, UIntPtr pContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpWebSocketCompleteUpgrade' -Namespace Win32 -PassThru
# $api::WinHttpWebSocketCompleteUpgrade(hRequest, pContext)#uselib "WINHTTP.dll"
#func global WinHttpWebSocketCompleteUpgrade "WinHttpWebSocketCompleteUpgrade" sptr, sptr
; WinHttpWebSocketCompleteUpgrade hRequest, pContext ; 戻り値は stat
; hRequest : void* -> "sptr"
; pContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WINHTTP.dll"
#cfunc global WinHttpWebSocketCompleteUpgrade "WinHttpWebSocketCompleteUpgrade" sptr, sptr
; res = WinHttpWebSocketCompleteUpgrade(hRequest, pContext)
; hRequest : void* -> "sptr"
; pContext : UINT_PTR optional -> "sptr"; void* WinHttpWebSocketCompleteUpgrade(void* hRequest, UINT_PTR pContext)
#uselib "WINHTTP.dll"
#cfunc global WinHttpWebSocketCompleteUpgrade "WinHttpWebSocketCompleteUpgrade" intptr, intptr
; res = WinHttpWebSocketCompleteUpgrade(hRequest, pContext)
; hRequest : void* -> "intptr"
; pContext : UINT_PTR optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
procWinHttpWebSocketCompleteUpgrade = winhttp.NewProc("WinHttpWebSocketCompleteUpgrade")
)
// hRequest (void*), pContext (UINT_PTR optional)
r1, _, err := procWinHttpWebSocketCompleteUpgrade.Call(
uintptr(hRequest),
uintptr(pContext),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // void*function WinHttpWebSocketCompleteUpgrade(
hRequest: Pointer; // void*
pContext: NativeUInt // UINT_PTR optional
): Pointer; stdcall;
external 'WINHTTP.dll' name 'WinHttpWebSocketCompleteUpgrade';result := DllCall("WINHTTP\WinHttpWebSocketCompleteUpgrade"
, "Ptr", hRequest ; void*
, "UPtr", pContext ; UINT_PTR optional
, "Ptr") ; return: void*●WinHttpWebSocketCompleteUpgrade(hRequest, pContext) = DLL("WINHTTP.dll", "void* WinHttpWebSocketCompleteUpgrade(void*, int)")
# 呼び出し: WinHttpWebSocketCompleteUpgrade(hRequest, pContext)
# hRequest : void* -> "void*"
# pContext : UINT_PTR optional -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "winhttp" fn WinHttpWebSocketCompleteUpgrade(
hRequest: ?*anyopaque, // void*
pContext: usize // UINT_PTR optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc WinHttpWebSocketCompleteUpgrade(
hRequest: pointer, # void*
pContext: uint # UINT_PTR optional
): pointer {.importc: "WinHttpWebSocketCompleteUpgrade", stdcall, dynlib: "WINHTTP.dll".}pragma(lib, "winhttp");
extern(Windows)
void* WinHttpWebSocketCompleteUpgrade(
void* hRequest, // void*
size_t pContext // UINT_PTR optional
);ccall((:WinHttpWebSocketCompleteUpgrade, "WINHTTP.dll"), stdcall, Ptr{Cvoid},
(Ptr{Cvoid}, Csize_t),
hRequest, pContext)
# hRequest : void* -> Ptr{Cvoid}
# pContext : UINT_PTR optional -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* WinHttpWebSocketCompleteUpgrade(
void* hRequest,
uintptr_t pContext);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpWebSocketCompleteUpgrade(hRequest, pContext)
-- hRequest : void*
-- pContext : UINT_PTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpWebSocketCompleteUpgrade = lib.func('__stdcall', 'WinHttpWebSocketCompleteUpgrade', 'void *', ['void *', 'uintptr_t']);
// WinHttpWebSocketCompleteUpgrade(hRequest, pContext)
// hRequest : void* -> 'void *'
// pContext : UINT_PTR optional -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WINHTTP.dll", {
WinHttpWebSocketCompleteUpgrade: { parameters: ["pointer", "usize"], result: "pointer" },
});
// lib.symbols.WinHttpWebSocketCompleteUpgrade(hRequest, pContext)
// hRequest : void* -> "pointer"
// pContext : UINT_PTR optional -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* WinHttpWebSocketCompleteUpgrade(
void* hRequest,
size_t pContext);
C, "WINHTTP.dll");
// $ffi->WinHttpWebSocketCompleteUpgrade(hRequest, pContext);
// hRequest : void*
// pContext : UINT_PTR optional
// 構造体/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);
Pointer WinHttpWebSocketCompleteUpgrade(
Pointer hRequest, // void*
long pContext // UINT_PTR optional
);
}@[Link("winhttp")]
lib LibWINHTTP
fun WinHttpWebSocketCompleteUpgrade = WinHttpWebSocketCompleteUpgrade(
hRequest : Void*, # void*
pContext : LibC::SizeT # UINT_PTR optional
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WinHttpWebSocketCompleteUpgradeNative = Pointer<Void> Function(Pointer<Void>, UintPtr);
typedef WinHttpWebSocketCompleteUpgradeDart = Pointer<Void> Function(Pointer<Void>, int);
final WinHttpWebSocketCompleteUpgrade = DynamicLibrary.open('WINHTTP.dll')
.lookupFunction<WinHttpWebSocketCompleteUpgradeNative, WinHttpWebSocketCompleteUpgradeDart>('WinHttpWebSocketCompleteUpgrade');
// hRequest : void* -> Pointer<Void>
// pContext : UINT_PTR optional -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WinHttpWebSocketCompleteUpgrade(
hRequest: Pointer; // void*
pContext: NativeUInt // UINT_PTR optional
): Pointer; stdcall;
external 'WINHTTP.dll' name 'WinHttpWebSocketCompleteUpgrade';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WinHttpWebSocketCompleteUpgrade"
c_WinHttpWebSocketCompleteUpgrade :: Ptr () -> CUIntPtr -> IO (Ptr ())
-- hRequest : void* -> Ptr ()
-- pContext : UINT_PTR optional -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let winhttpwebsocketcompleteupgrade =
foreign "WinHttpWebSocketCompleteUpgrade"
((ptr void) @-> size_t @-> returning (ptr void))
(* hRequest : void* -> (ptr void) *)
(* pContext : UINT_PTR optional -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)
(cffi:defcfun ("WinHttpWebSocketCompleteUpgrade" win-http-web-socket-complete-upgrade :convention :stdcall) :pointer
(h-request :pointer) ; void*
(p-context :uint64)) ; UINT_PTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WinHttpWebSocketCompleteUpgrade = Win32::API::More->new('WINHTTP',
'LPVOID WinHttpWebSocketCompleteUpgrade(LPVOID hRequest, WPARAM pContext)');
# my $ret = $WinHttpWebSocketCompleteUpgrade->Call($hRequest, $pContext);
# hRequest : void* -> LPVOID
# pContext : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。