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

HttpReceiveClientCertificate

関数
クライアントのSSL証明書情報を受信する。
DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpReceiveClientCertificate(
    HANDLE RequestQueueHandle,
    ULONGLONG ConnectionId,
    DWORD Flags,
    HTTP_SSL_CLIENT_CERT_INFO* SslClientCertInfo,
    DWORD SslClientCertInfoSize,
    DWORD* BytesReceived,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前方向
RequestQueueHandleHANDLEin
ConnectionIdULONGLONGin
FlagsDWORDin
SslClientCertInfoHTTP_SSL_CLIENT_CERT_INFO*out
SslClientCertInfoSizeDWORDin
BytesReceivedDWORD*outoptional
OverlappedOVERLAPPED*inoutoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD HttpReceiveClientCertificate(
    HANDLE RequestQueueHandle,
    ULONGLONG ConnectionId,
    DWORD Flags,
    HTTP_SSL_CLIENT_CERT_INFO* SslClientCertInfo,
    DWORD SslClientCertInfoSize,
    DWORD* BytesReceived,   // optional
    OVERLAPPED* Overlapped   // optional
);
[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpReceiveClientCertificate(
    IntPtr RequestQueueHandle,   // HANDLE
    ulong ConnectionId,   // ULONGLONG
    uint Flags,   // DWORD
    IntPtr SslClientCertInfo,   // HTTP_SSL_CLIENT_CERT_INFO* out
    uint SslClientCertInfoSize,   // DWORD
    IntPtr BytesReceived,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);
<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpReceiveClientCertificate(
    RequestQueueHandle As IntPtr,   ' HANDLE
    ConnectionId As ULong,   ' ULONGLONG
    Flags As UInteger,   ' DWORD
    SslClientCertInfo As IntPtr,   ' HTTP_SSL_CLIENT_CERT_INFO* out
    SslClientCertInfoSize As UInteger,   ' DWORD
    BytesReceived As IntPtr,   ' DWORD* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As UInteger
End Function
' RequestQueueHandle : HANDLE
' ConnectionId : ULONGLONG
' Flags : DWORD
' SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out
' SslClientCertInfoSize : DWORD
' BytesReceived : DWORD* optional, out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function HttpReceiveClientCertificate Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal ConnectionId As LongLong, _
    ByVal Flags As Long, _
    ByVal SslClientCertInfo As LongPtr, _
    ByVal SslClientCertInfoSize As Long, _
    ByVal BytesReceived As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpReceiveClientCertificate = ctypes.windll.httpapi.HttpReceiveClientCertificate
HttpReceiveClientCertificate.restype = wintypes.DWORD
HttpReceiveClientCertificate.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    ctypes.c_ulonglong,  # ConnectionId : ULONGLONG
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out
    wintypes.DWORD,  # SslClientCertInfoSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # BytesReceived : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpReceiveClientCertificate = Fiddle::Function.new(
  lib['HttpReceiveClientCertificate'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # ConnectionId : ULONGLONG
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out
    -Fiddle::TYPE_INT,  # SslClientCertInfoSize : DWORD
    Fiddle::TYPE_VOIDP,  # BytesReceived : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "httpapi")]
extern "system" {
    fn HttpReceiveClientCertificate(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        ConnectionId: u64,  // ULONGLONG
        Flags: u32,  // DWORD
        SslClientCertInfo: *mut HTTP_SSL_CLIENT_CERT_INFO,  // HTTP_SSL_CLIENT_CERT_INFO* out
        SslClientCertInfoSize: u32,  // DWORD
        BytesReceived: *mut u32,  // DWORD* optional, out
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpReceiveClientCertificate(IntPtr RequestQueueHandle, ulong ConnectionId, uint Flags, IntPtr SslClientCertInfo, uint SslClientCertInfoSize, IntPtr BytesReceived, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpReceiveClientCertificate' -Namespace Win32 -PassThru
# $api::HttpReceiveClientCertificate(RequestQueueHandle, ConnectionId, Flags, SslClientCertInfo, SslClientCertInfoSize, BytesReceived, Overlapped)
#uselib "HTTPAPI.dll"
#func global HttpReceiveClientCertificate "HttpReceiveClientCertificate" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; HttpReceiveClientCertificate RequestQueueHandle, ConnectionId, Flags, varptr(SslClientCertInfo), SslClientCertInfoSize, varptr(BytesReceived), varptr(Overlapped)   ; 戻り値は stat
; RequestQueueHandle : HANDLE -> "sptr"
; ConnectionId : ULONGLONG -> "sptr"
; Flags : DWORD -> "sptr"
; SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out -> "sptr"
; SslClientCertInfoSize : DWORD -> "sptr"
; BytesReceived : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "HTTPAPI.dll"
#cfunc global HttpReceiveClientCertificate "HttpReceiveClientCertificate" sptr, int64, int, var, int, var, var
; res = HttpReceiveClientCertificate(RequestQueueHandle, ConnectionId, Flags, SslClientCertInfo, SslClientCertInfoSize, BytesReceived, Overlapped)
; RequestQueueHandle : HANDLE -> "sptr"
; ConnectionId : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out -> "var"
; SslClientCertInfoSize : DWORD -> "int"
; BytesReceived : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; DWORD HttpReceiveClientCertificate(HANDLE RequestQueueHandle, ULONGLONG ConnectionId, DWORD Flags, HTTP_SSL_CLIENT_CERT_INFO* SslClientCertInfo, DWORD SslClientCertInfoSize, DWORD* BytesReceived, OVERLAPPED* Overlapped)
#uselib "HTTPAPI.dll"
#cfunc global HttpReceiveClientCertificate "HttpReceiveClientCertificate" intptr, int64, int, var, int, var, var
; res = HttpReceiveClientCertificate(RequestQueueHandle, ConnectionId, Flags, SslClientCertInfo, SslClientCertInfoSize, BytesReceived, Overlapped)
; RequestQueueHandle : HANDLE -> "intptr"
; ConnectionId : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out -> "var"
; SslClientCertInfoSize : DWORD -> "int"
; BytesReceived : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpReceiveClientCertificate = httpapi.NewProc("HttpReceiveClientCertificate")
)

// RequestQueueHandle (HANDLE), ConnectionId (ULONGLONG), Flags (DWORD), SslClientCertInfo (HTTP_SSL_CLIENT_CERT_INFO* out), SslClientCertInfoSize (DWORD), BytesReceived (DWORD* optional, out), Overlapped (OVERLAPPED* optional, in/out)
r1, _, err := procHttpReceiveClientCertificate.Call(
	uintptr(RequestQueueHandle),
	uintptr(ConnectionId),
	uintptr(Flags),
	uintptr(SslClientCertInfo),
	uintptr(SslClientCertInfoSize),
	uintptr(BytesReceived),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function HttpReceiveClientCertificate(
  RequestQueueHandle: THandle;   // HANDLE
  ConnectionId: UInt64;   // ULONGLONG
  Flags: DWORD;   // DWORD
  SslClientCertInfo: Pointer;   // HTTP_SSL_CLIENT_CERT_INFO* out
  SslClientCertInfoSize: DWORD;   // DWORD
  BytesReceived: Pointer;   // DWORD* optional, out
  Overlapped: Pointer   // OVERLAPPED* optional, in/out
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpReceiveClientCertificate';
result := DllCall("HTTPAPI\HttpReceiveClientCertificate"
    , "Ptr", RequestQueueHandle   ; HANDLE
    , "Int64", ConnectionId   ; ULONGLONG
    , "UInt", Flags   ; DWORD
    , "Ptr", SslClientCertInfo   ; HTTP_SSL_CLIENT_CERT_INFO* out
    , "UInt", SslClientCertInfoSize   ; DWORD
    , "Ptr", BytesReceived   ; DWORD* optional, out
    , "Ptr", Overlapped   ; OVERLAPPED* optional, in/out
    , "UInt")   ; return: DWORD
●HttpReceiveClientCertificate(RequestQueueHandle, ConnectionId, Flags, SslClientCertInfo, SslClientCertInfoSize, BytesReceived, Overlapped) = DLL("HTTPAPI.dll", "dword HttpReceiveClientCertificate(void*, qword, dword, void*, dword, void*, void*)")
# 呼び出し: HttpReceiveClientCertificate(RequestQueueHandle, ConnectionId, Flags, SslClientCertInfo, SslClientCertInfoSize, BytesReceived, Overlapped)
# RequestQueueHandle : HANDLE -> "void*"
# ConnectionId : ULONGLONG -> "qword"
# Flags : DWORD -> "dword"
# SslClientCertInfo : HTTP_SSL_CLIENT_CERT_INFO* out -> "void*"
# SslClientCertInfoSize : DWORD -> "dword"
# BytesReceived : DWORD* optional, out -> "void*"
# Overlapped : OVERLAPPED* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。