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

HttpAddUrl

関数
リクエストキューにURLを登録して待ち受ける。
DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpAddUrl(
    HANDLE RequestQueueHandle,
    LPCWSTR FullyQualifiedUrl,
    void* Reserved   // optional
);

パラメーター

名前方向説明
RequestQueueHandleHANDLEin

指定された URL に対するリクエストのルーティング先となるリクエストキューへのハンドル。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。

Windows Server 2003 with SP1 および Windows XP with SP2: リクエストキューへのハンドルは HttpCreateHttpHandle 関数によって作成されます。

FullyQualifiedUrlLPCWSTRin登録する URL を識別する、適切な形式の UrlPrefix 文字列 を含む Unicode 文字列へのポインター。
Reservedvoid*optional予約済み。NULL を指定する必要があります。

戻り値の型: DWORD

公式ドキュメント

指定された URL を登録し、それに一致するリクエストが、指定された HTTP Server API リクエストキューにルーティングされるようにします。

戻り値

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

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

意味
ERROR_ACCESS_DENIED
呼び出し元アプリケーションに、URL を登録する権限がありません。
ERROR_DLL_INIT_FAILED
呼び出し元アプリケーションが、この関数を呼び出す前に HttpInitialize を呼び出していません。
ERROR_INVALID_PARAMETER
パラメーターのいずれかが無効です。
ERROR_ALREADY_EXISTS
指定された UrlPrefix が、既存の登録と競合しています。
ERROR_NOT_ENOUGH_MEMORY
操作を完了するためのリソースが不足しています。
その他
WinError.h で定義されている システムエラーコード

解説(Remarks)

UrlPrefix Strings のトピックで述べられているとおり、登録する UrlPrefix のスキーム指定は、小文字の "http" または小文字の "https" のいずれかでなければなりません。それ以外の部分文字列は無効です。

また、同一ポート上に異なるスキームの URL を登録することはできません。つまり、"http" スキームと "https" スキームは同一ポート上で共存できません。

さらに、HttpAddUrl は、文字列が適切な形式である限り、渡された UrlPrefix をすべて登録することにも注意してください。指定された URL 名前空間の存在、アクセス可能性、所有権、その他の特性の検証は、アプリケーション側で処理する必要があります。

HttpAddUrl による登録の結果として割り当てられたリソースを解放するには、対象の名前空間の使用がアプリケーションで完了した時点で、対応する HttpRemoveUrl 関数の呼び出しを行ってください。

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

各言語での呼び出し定義

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

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

HttpAddUrl = ctypes.windll.httpapi.HttpAddUrl
HttpAddUrl.restype = wintypes.DWORD
HttpAddUrl.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    wintypes.LPCWSTR,  # FullyQualifiedUrl : LPCWSTR
    ctypes.POINTER(None),  # Reserved : void* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpAddUrl = httpapi.NewProc("HttpAddUrl")
)

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

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

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

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

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

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

関連項目

公式の関連項目