ホーム › Networking.HttpServer › HttpInitialize
HttpInitialize
関数HTTP Server APIを初期化して使用準備する。
シグネチャ
// HTTPAPI.dll
#include <windows.h>
DWORD HttpInitialize(
HTTPAPI_VERSION Version,
HTTP_INITIALIZE Flags,
void* pReserved // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Version | HTTPAPI_VERSION | in | HTTP のバージョン。このパラメーターは HTTPAPI_VERSION 構造体です。現在のバージョンを使用するには、この構造体のインスタンスを宣言し、 HttpInitialize に渡す前に、定義済みの値 HTTPAPI_VERSION_1 を設定します。 | ||||||
| Flags | HTTP_INITIALIZE | in | 初期化オプション。次の値の一方または両方を指定できます。
| ||||||
| pReserved | void* | inoutoptional | このパラメーターは予約されており、NULL である必要があります。 |
戻り値の型: DWORD
公式ドキュメント
HttpInitialize 関数は HTTP Server API ドライバーを初期化し、まだ開始されていない場合は開始して、呼び出し元アプリケーションがレスポンスキューの作成やその他の操作を行えるよう、データ構造を割り当てます。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラーコードです。
| 値 | 意味 |
|---|---|
| Flags パラメーターにサポートされていない値が含まれています。 | |
|
WinError.h で定義されている システムエラーコード。 |
解説(Remarks)
アプリケーションが完了したら HttpTerminate を呼び出します。Flags パラメーターで HttpInitialize に渡したすべてのフラグは、 HttpTerminate にも渡す必要があります。各 HttpInitialize の呼び出しが、後で対応する HttpTerminate の呼び出しと一致する限り、アプリケーションは HttpInitialize を繰り返し呼び出すことができます。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// HTTPAPI.dll
#include <windows.h>
DWORD HttpInitialize(
HTTPAPI_VERSION Version,
HTTP_INITIALIZE Flags,
void* pReserved // optional
);[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpInitialize(
HTTPAPI_VERSION Version, // HTTPAPI_VERSION
uint Flags, // HTTP_INITIALIZE
IntPtr pReserved // void* optional, in/out
);<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpInitialize(
Version As HTTPAPI_VERSION, ' HTTPAPI_VERSION
Flags As UInteger, ' HTTP_INITIALIZE
pReserved As IntPtr ' void* optional, in/out
) As UInteger
End Function' Version : HTTPAPI_VERSION
' Flags : HTTP_INITIALIZE
' pReserved : void* optional, in/out
Declare PtrSafe Function HttpInitialize Lib "httpapi" ( _
ByVal Version As LongPtr, _
ByVal Flags As Long, _
ByVal pReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
HttpInitialize = ctypes.windll.httpapi.HttpInitialize
HttpInitialize.restype = wintypes.DWORD
HttpInitialize.argtypes = [
HTTPAPI_VERSION, # Version : HTTPAPI_VERSION
wintypes.DWORD, # Flags : HTTP_INITIALIZE
ctypes.POINTER(None), # pReserved : void* optional, in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('HTTPAPI.dll')
HttpInitialize = Fiddle::Function.new(
lib['HttpInitialize'],
[
Fiddle::TYPE_VOIDP, # Version : HTTPAPI_VERSION
-Fiddle::TYPE_INT, # Flags : HTTP_INITIALIZE
Fiddle::TYPE_VOIDP, # pReserved : void* optional, in/out
],
-Fiddle::TYPE_INT)#[link(name = "httpapi")]
extern "system" {
fn HttpInitialize(
Version: HTTPAPI_VERSION, // HTTPAPI_VERSION
Flags: u32, // HTTP_INITIALIZE
pReserved: *mut () // void* optional, in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpInitialize(HTTPAPI_VERSION Version, uint Flags, IntPtr pReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpInitialize' -Namespace Win32 -PassThru
# $api::HttpInitialize(Version, Flags, pReserved)#uselib "HTTPAPI.dll"
#func global HttpInitialize "HttpInitialize" sptr, sptr, sptr
; HttpInitialize Version, Flags, pReserved ; 戻り値は stat
; Version : HTTPAPI_VERSION -> "sptr"
; Flags : HTTP_INITIALIZE -> "sptr"
; pReserved : void* optional, in/out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "HTTPAPI.dll"
#cfunc global HttpInitialize "HttpInitialize" int, int, sptr
; res = HttpInitialize(Version, Flags, pReserved)
; Version : HTTPAPI_VERSION -> "int"
; Flags : HTTP_INITIALIZE -> "int"
; pReserved : void* optional, in/out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。; DWORD HttpInitialize(HTTPAPI_VERSION Version, HTTP_INITIALIZE Flags, void* pReserved)
#uselib "HTTPAPI.dll"
#cfunc global HttpInitialize "HttpInitialize" int, int, intptr
; res = HttpInitialize(Version, Flags, pReserved)
; Version : HTTPAPI_VERSION -> "int"
; Flags : HTTP_INITIALIZE -> "int"
; pReserved : void* optional, in/out -> "intptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
procHttpInitialize = httpapi.NewProc("HttpInitialize")
)
// Version (HTTPAPI_VERSION), Flags (HTTP_INITIALIZE), pReserved (void* optional, in/out)
r1, _, err := procHttpInitialize.Call(
uintptr(Version),
uintptr(Flags),
uintptr(pReserved),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction HttpInitialize(
Version: HTTPAPI_VERSION; // HTTPAPI_VERSION
Flags: DWORD; // HTTP_INITIALIZE
pReserved: Pointer // void* optional, in/out
): DWORD; stdcall;
external 'HTTPAPI.dll' name 'HttpInitialize';result := DllCall("HTTPAPI\HttpInitialize"
, "Ptr", Version ; HTTPAPI_VERSION
, "UInt", Flags ; HTTP_INITIALIZE
, "Ptr", pReserved ; void* optional, in/out
, "UInt") ; return: DWORD●HttpInitialize(Version, Flags, pReserved) = DLL("HTTPAPI.dll", "dword HttpInitialize(void*, dword, void*)")
# 呼び出し: HttpInitialize(Version, Flags, pReserved)
# Version : HTTPAPI_VERSION -> "void*"
# Flags : HTTP_INITIALIZE -> "dword"
# pReserved : void* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "httpapi" fn HttpInitialize(
Version: HTTPAPI_VERSION, // HTTPAPI_VERSION
Flags: u32, // HTTP_INITIALIZE
pReserved: ?*anyopaque // void* optional, in/out
) callconv(std.os.windows.WINAPI) u32;proc HttpInitialize(
Version: HTTPAPI_VERSION, # HTTPAPI_VERSION
Flags: uint32, # HTTP_INITIALIZE
pReserved: pointer # void* optional, in/out
): uint32 {.importc: "HttpInitialize", stdcall, dynlib: "HTTPAPI.dll".}pragma(lib, "httpapi");
extern(Windows)
uint HttpInitialize(
HTTPAPI_VERSION Version, // HTTPAPI_VERSION
uint Flags, // HTTP_INITIALIZE
void* pReserved // void* optional, in/out
);ccall((:HttpInitialize, "HTTPAPI.dll"), stdcall, UInt32,
(HTTPAPI_VERSION, UInt32, Ptr{Cvoid}),
Version, Flags, pReserved)
# Version : HTTPAPI_VERSION -> HTTPAPI_VERSION
# Flags : HTTP_INITIALIZE -> UInt32
# pReserved : void* optional, in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t HttpInitialize(
HTTPAPI_VERSION Version,
uint32_t Flags,
void* pReserved);
]]
local httpapi = ffi.load("httpapi")
-- httpapi.HttpInitialize(Version, Flags, pReserved)
-- Version : HTTPAPI_VERSION
-- Flags : HTTP_INITIALIZE
-- pReserved : void* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('HTTPAPI.dll');
const HttpInitialize = lib.func('__stdcall', 'HttpInitialize', 'uint32_t', ['HTTPAPI_VERSION', 'uint32_t', 'void *']);
// HttpInitialize(Version, Flags, pReserved)
// Version : HTTPAPI_VERSION -> 'HTTPAPI_VERSION'
// Flags : HTTP_INITIALIZE -> 'uint32_t'
// pReserved : void* optional, in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("HTTPAPI.dll", {
HttpInitialize: { parameters: ["buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.HttpInitialize(Version, Flags, pReserved)
// Version : HTTPAPI_VERSION -> "buffer"
// Flags : HTTP_INITIALIZE -> "u32"
// pReserved : void* optional, in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t HttpInitialize(
HTTPAPI_VERSION Version,
uint32_t Flags,
void* pReserved);
C, "HTTPAPI.dll");
// $ffi->HttpInitialize(Version, Flags, pReserved);
// Version : HTTPAPI_VERSION
// Flags : HTTP_INITIALIZE
// pReserved : void* optional, in/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 Httpapi extends StdCallLibrary {
Httpapi INSTANCE = Native.load("httpapi", Httpapi.class);
int HttpInitialize(
HTTPAPI_VERSION /* extends Structure (by value) */ Version, // HTTPAPI_VERSION
int Flags, // HTTP_INITIALIZE
Pointer pReserved // void* optional, in/out
);
}@[Link("httpapi")]
lib LibHTTPAPI
fun HttpInitialize = HttpInitialize(
Version : HTTPAPI_VERSION, # HTTPAPI_VERSION
Flags : UInt32, # HTTP_INITIALIZE
pReserved : Void* # void* optional, in/out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef HttpInitializeNative = Uint32 Function(HTTPAPI_VERSION, Uint32, Pointer<Void>);
typedef HttpInitializeDart = int Function(int, int, Pointer<Void>);
final HttpInitialize = DynamicLibrary.open('HTTPAPI.dll')
.lookupFunction<HttpInitializeNative, HttpInitializeDart>('HttpInitialize');
// Version : HTTPAPI_VERSION -> HTTPAPI_VERSION
// Flags : HTTP_INITIALIZE -> Uint32
// pReserved : void* optional, in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function HttpInitialize(
Version: HTTPAPI_VERSION; // HTTPAPI_VERSION
Flags: DWORD; // HTTP_INITIALIZE
pReserved: Pointer // void* optional, in/out
): DWORD; stdcall;
external 'HTTPAPI.dll' name 'HttpInitialize';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "HttpInitialize"
c_HttpInitialize :: HTTPAPI_VERSION -> Word32 -> Ptr () -> IO Word32
-- Version : HTTPAPI_VERSION -> HTTPAPI_VERSION
-- Flags : HTTP_INITIALIZE -> Word32
-- pReserved : void* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。open Ctypes
open Foreign
let httpinitialize =
foreign "HttpInitialize"
(HTTPAPI_VERSION @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* Version : HTTPAPI_VERSION -> HTTPAPI_VERSION *)
(* Flags : HTTP_INITIALIZE -> uint32_t *)
(* pReserved : void* optional, in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library httpapi (t "HTTPAPI.dll"))
(cffi:use-foreign-library httpapi)
(cffi:defcfun ("HttpInitialize" http-initialize :convention :stdcall) :uint32
(version (:struct httpapi-version)) ; HTTPAPI_VERSION
(flags :uint32) ; HTTP_INITIALIZE
(p-reserved :pointer)) ; void* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $HttpInitialize = Win32::API::More->new('HTTPAPI',
'DWORD HttpInitialize(LPVOID Version, DWORD Flags, LPVOID pReserved)');
# my $ret = $HttpInitialize->Call($Version, $Flags, $pReserved);
# Version : HTTPAPI_VERSION -> LPVOID
# Flags : HTTP_INITIALIZE -> DWORD
# pReserved : void* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f HttpTerminate — HTTP Server APIを終了して資源を解放する。