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

HttpCreateHttpHandle

関数
リクエストキュー用のHTTPハンドルを作成する。
DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpCreateHttpHandle(
    HANDLE* RequestQueueHandle,
    DWORD Reserved   // optional
);

パラメーター

名前方向説明
RequestQueueHandleHANDLE*outリクエストキューのハンドルを受け取る変数へのポインターです。
ReservedDWORDoptional予約済みです。このパラメーターはゼロでなければなりません。

戻り値の型: DWORD

公式ドキュメント

呼び出し元アプリケーションのために HTTP リクエストキューを作成し、そのハンドルを返します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

意味
ERROR_DLL_INIT_FAILED
呼び出し元アプリケーションが、この関数を呼び出す前に HttpInitialize を呼び出していませんでした。
その他
WinError.h で定義されている システムエラーコード です。

解説(Remarks)

リクエストキューにより、呼び出し元アプリケーションは特定の URL に対するリクエストを受信できます。呼び出し元アプリケーションは HttpAddUrl 関数を使用して、リクエストを受信する対象の URL を指定します。

アプリケーションはリクエストの受信に単一のリクエストキューを使用してください。1 つのプロセスから複数のリクエストキューを使用しても、応答時間やスループットは向上しません。

アプリケーションがリクエストの受信を終えたら、 CloseHandle 関数を呼び出してハンドルを閉じてください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

HttpCreateHttpHandle = ctypes.windll.httpapi.HttpCreateHttpHandle
HttpCreateHttpHandle.restype = wintypes.DWORD
HttpCreateHttpHandle.argtypes = [
    ctypes.c_void_p,  # RequestQueueHandle : HANDLE* out
    wintypes.DWORD,  # Reserved : DWORD optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpCreateHttpHandle = httpapi.NewProc("HttpCreateHttpHandle")
)

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

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

typedef HttpCreateHttpHandleNative = Uint32 Function(Pointer<Void>, Uint32);
typedef HttpCreateHttpHandleDart = int Function(Pointer<Void>, int);
final HttpCreateHttpHandle = DynamicLibrary.open('HTTPAPI.dll')
    .lookupFunction<HttpCreateHttpHandleNative, HttpCreateHttpHandleDart>('HttpCreateHttpHandle');
// RequestQueueHandle : HANDLE* out -> Pointer<Void>
// Reserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpCreateHttpHandle(
  RequestQueueHandle: Pointer;   // HANDLE* out
  Reserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpCreateHttpHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpCreateHttpHandle"
  c_HttpCreateHttpHandle :: Ptr () -> Word32 -> IO Word32
-- RequestQueueHandle : HANDLE* out -> Ptr ()
-- Reserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let httpcreatehttphandle =
  foreign "HttpCreateHttpHandle"
    ((ptr void) @-> uint32_t @-> returning uint32_t)
(* RequestQueueHandle : HANDLE* out -> (ptr void) *)
(* Reserved : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library httpapi (t "HTTPAPI.dll"))
(cffi:use-foreign-library httpapi)

(cffi:defcfun ("HttpCreateHttpHandle" http-create-http-handle :convention :stdcall) :uint32
  (request-queue-handle :pointer)   ; HANDLE* out
  (reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpCreateHttpHandle = Win32::API::More->new('HTTPAPI',
    'DWORD HttpCreateHttpHandle(HANDLE RequestQueueHandle, DWORD Reserved)');
# my $ret = $HttpCreateHttpHandle->Call($RequestQueueHandle, $Reserved);
# RequestQueueHandle : HANDLE* out -> HANDLE
# Reserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目