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

HttpAddUrlToUrlGroup

関数
URLグループにURLを追加する。
DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpAddUrlToUrlGroup(
    ULONGLONG UrlGroupId,
    LPCWSTR pFullyQualifiedUrl,
    ULONGLONG UrlContext,
    DWORD Reserved   // optional
);

パラメーター

名前方向説明
UrlGroupIdULONGLONGin指定した URL に対する要求のルーティング先となる URL グループのグループ ID。URL グループは HttpCreateUrlGroup 関数によって作成されます。
pFullyQualifiedUrlLPCWSTRin登録する URL を識別する、正しく構成された UrlPrefix String を含む Unicode 文字列へのポインター。管理者として実行していない場合は 1024 より大きいポート番号を指定してください。指定しないと ERROR_ACCESS_DENIED エラーが発生することがあります。
UrlContextULONGLONGinこの呼び出しで登録される URL に関連付けられるコンテキスト。URL コンテキストは、pFullyQualifiedUrl パラメーターで指定した URL で受信されたすべての要求に対して、HTTP_REQUEST 構造体内で返されます。
ReservedDWORDinoptional予約済み。ゼロである必要があります。

戻り値の型: DWORD

公式ドキュメント

URL グループ ID で識別される URL グループに、指定した URL を追加します。

戻り値

関数が成功すると、NO_ERROR を返します。

関数が失敗した場合は、次のいずれかのエラー コードを返します。

意味
ERROR_INVALID_PARAMETER
UrlGroupId が存在しません。

Reserved パラメーターがゼロではありません。

アプリケーションにグループへ URL を追加する権限がありません。URL を追加できるのは、その URL グループを作成したアプリケーションのみです。

ERROR_ACCESS_DENIED
呼び出し元のプロセスに、URL を登録する権限がありません。
ERROR_ALREADY_EXISTS
指定した URL が既存の登録と競合しています。

解説(Remarks)

HTTP Server API は、バージョン 1.0 の URL 登録を使用する既存のアプリケーションをサポートしますが、HTTP Server API を用いた新規開発では HttpAddUrlToUrlGroup を使用してください。HttpAddUrl は使用しないでください。

アプリケーションは、HttpAddUrlToUrlGroup を繰り返し呼び出すことで、複数の URL を URL グループに追加できます。指定した URL に一致する要求は、その URL グループに関連付けられた要求キューにルーティングされます。HTTP Server API が要求 URL を登録済み URL に照合する方法の詳細については、UrlPrefix Strings を参照してください。

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

各言語での呼び出し定義

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

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

HttpAddUrlToUrlGroup = ctypes.windll.httpapi.HttpAddUrlToUrlGroup
HttpAddUrlToUrlGroup.restype = wintypes.DWORD
HttpAddUrlToUrlGroup.argtypes = [
    ctypes.c_ulonglong,  # UrlGroupId : ULONGLONG
    wintypes.LPCWSTR,  # pFullyQualifiedUrl : LPCWSTR
    ctypes.c_ulonglong,  # UrlContext : ULONGLONG
    wintypes.DWORD,  # Reserved : DWORD optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpAddUrlToUrlGroup = Fiddle::Function.new(
  lib['HttpAddUrlToUrlGroup'],
  [
    -Fiddle::TYPE_LONG_LONG,  # UrlGroupId : ULONGLONG
    Fiddle::TYPE_VOIDP,  # pFullyQualifiedUrl : LPCWSTR
    -Fiddle::TYPE_LONG_LONG,  # UrlContext : ULONGLONG
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "httpapi")]
extern "system" {
    fn HttpAddUrlToUrlGroup(
        UrlGroupId: u64,  // ULONGLONG
        pFullyQualifiedUrl: *const u16,  // LPCWSTR
        UrlContext: u64,  // ULONGLONG
        Reserved: u32  // DWORD optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpAddUrlToUrlGroup(ulong UrlGroupId, [MarshalAs(UnmanagedType.LPWStr)] string pFullyQualifiedUrl, ulong UrlContext, uint Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpAddUrlToUrlGroup' -Namespace Win32 -PassThru
# $api::HttpAddUrlToUrlGroup(UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved)
#uselib "HTTPAPI.dll"
#func global HttpAddUrlToUrlGroup "HttpAddUrlToUrlGroup" sptr, sptr, sptr, sptr
; HttpAddUrlToUrlGroup UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved   ; 戻り値は stat
; UrlGroupId : ULONGLONG -> "sptr"
; pFullyQualifiedUrl : LPCWSTR -> "sptr"
; UrlContext : ULONGLONG -> "sptr"
; Reserved : DWORD optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "HTTPAPI.dll"
#cfunc global HttpAddUrlToUrlGroup "HttpAddUrlToUrlGroup" int64, wstr, int64, int
; res = HttpAddUrlToUrlGroup(UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved)
; UrlGroupId : ULONGLONG -> "int64"
; pFullyQualifiedUrl : LPCWSTR -> "wstr"
; UrlContext : ULONGLONG -> "int64"
; Reserved : DWORD optional -> "int"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; DWORD HttpAddUrlToUrlGroup(ULONGLONG UrlGroupId, LPCWSTR pFullyQualifiedUrl, ULONGLONG UrlContext, DWORD Reserved)
#uselib "HTTPAPI.dll"
#cfunc global HttpAddUrlToUrlGroup "HttpAddUrlToUrlGroup" int64, wstr, int64, int
; res = HttpAddUrlToUrlGroup(UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved)
; UrlGroupId : ULONGLONG -> "int64"
; pFullyQualifiedUrl : LPCWSTR -> "wstr"
; UrlContext : ULONGLONG -> "int64"
; Reserved : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpAddUrlToUrlGroup = httpapi.NewProc("HttpAddUrlToUrlGroup")
)

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

extern "httpapi" fn HttpAddUrlToUrlGroup(
    UrlGroupId: u64, // ULONGLONG
    pFullyQualifiedUrl: [*c]const u16, // LPCWSTR
    UrlContext: u64, // ULONGLONG
    Reserved: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) u32;
proc HttpAddUrlToUrlGroup(
    UrlGroupId: uint64,  # ULONGLONG
    pFullyQualifiedUrl: WideCString,  # LPCWSTR
    UrlContext: uint64,  # ULONGLONG
    Reserved: uint32  # DWORD optional
): uint32 {.importc: "HttpAddUrlToUrlGroup", stdcall, dynlib: "HTTPAPI.dll".}
pragma(lib, "httpapi");
extern(Windows)
uint HttpAddUrlToUrlGroup(
    ulong UrlGroupId,   // ULONGLONG
    const(wchar)* pFullyQualifiedUrl,   // LPCWSTR
    ulong UrlContext,   // ULONGLONG
    uint Reserved   // DWORD optional
);
ccall((:HttpAddUrlToUrlGroup, "HTTPAPI.dll"), stdcall, UInt32,
      (UInt64, Cwstring, UInt64, UInt32),
      UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved)
# UrlGroupId : ULONGLONG -> UInt64
# pFullyQualifiedUrl : LPCWSTR -> Cwstring
# UrlContext : ULONGLONG -> UInt64
# Reserved : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t HttpAddUrlToUrlGroup(
    uint64_t UrlGroupId,
    const uint16_t* pFullyQualifiedUrl,
    uint64_t UrlContext,
    uint32_t Reserved);
]]
local httpapi = ffi.load("httpapi")
-- httpapi.HttpAddUrlToUrlGroup(UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved)
-- UrlGroupId : ULONGLONG
-- pFullyQualifiedUrl : LPCWSTR
-- UrlContext : ULONGLONG
-- Reserved : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('HTTPAPI.dll');
const HttpAddUrlToUrlGroup = lib.func('__stdcall', 'HttpAddUrlToUrlGroup', 'uint32_t', ['uint64_t', 'str16', 'uint64_t', 'uint32_t']);
// HttpAddUrlToUrlGroup(UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved)
// UrlGroupId : ULONGLONG -> 'uint64_t'
// pFullyQualifiedUrl : LPCWSTR -> 'str16'
// UrlContext : ULONGLONG -> 'uint64_t'
// Reserved : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("HTTPAPI.dll", {
  HttpAddUrlToUrlGroup: { parameters: ["u64", "buffer", "u64", "u32"], result: "u32" },
});
// lib.symbols.HttpAddUrlToUrlGroup(UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved)
// UrlGroupId : ULONGLONG -> "u64"
// pFullyQualifiedUrl : LPCWSTR -> "buffer"
// UrlContext : ULONGLONG -> "u64"
// Reserved : DWORD optional -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t HttpAddUrlToUrlGroup(
    uint64_t UrlGroupId,
    const uint16_t* pFullyQualifiedUrl,
    uint64_t UrlContext,
    uint32_t Reserved);
C, "HTTPAPI.dll");
// $ffi->HttpAddUrlToUrlGroup(UrlGroupId, pFullyQualifiedUrl, UrlContext, Reserved);
// UrlGroupId : ULONGLONG
// pFullyQualifiedUrl : LPCWSTR
// UrlContext : ULONGLONG
// 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 HttpAddUrlToUrlGroup(
        long UrlGroupId,   // ULONGLONG
        WString pFullyQualifiedUrl,   // LPCWSTR
        long UrlContext,   // ULONGLONG
        int Reserved   // DWORD optional
    );
}
@[Link("httpapi")]
lib LibHTTPAPI
  fun HttpAddUrlToUrlGroup = HttpAddUrlToUrlGroup(
    UrlGroupId : UInt64,   # ULONGLONG
    pFullyQualifiedUrl : UInt16*,   # LPCWSTR
    UrlContext : UInt64,   # ULONGLONG
    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 HttpAddUrlToUrlGroupNative = Uint32 Function(Uint64, Pointer<Utf16>, Uint64, Uint32);
typedef HttpAddUrlToUrlGroupDart = int Function(int, Pointer<Utf16>, int, int);
final HttpAddUrlToUrlGroup = DynamicLibrary.open('HTTPAPI.dll')
    .lookupFunction<HttpAddUrlToUrlGroupNative, HttpAddUrlToUrlGroupDart>('HttpAddUrlToUrlGroup');
// UrlGroupId : ULONGLONG -> Uint64
// pFullyQualifiedUrl : LPCWSTR -> Pointer<Utf16>
// UrlContext : ULONGLONG -> Uint64
// Reserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpAddUrlToUrlGroup(
  UrlGroupId: UInt64;   // ULONGLONG
  pFullyQualifiedUrl: PWideChar;   // LPCWSTR
  UrlContext: UInt64;   // ULONGLONG
  Reserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpAddUrlToUrlGroup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpAddUrlToUrlGroup"
  c_HttpAddUrlToUrlGroup :: Word64 -> CWString -> Word64 -> Word32 -> IO Word32
-- UrlGroupId : ULONGLONG -> Word64
-- pFullyQualifiedUrl : LPCWSTR -> CWString
-- UrlContext : ULONGLONG -> Word64
-- Reserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let httpaddurltourlgroup =
  foreign "HttpAddUrlToUrlGroup"
    (uint64_t @-> (ptr uint16_t) @-> uint64_t @-> uint32_t @-> returning uint32_t)
(* UrlGroupId : ULONGLONG -> uint64_t *)
(* pFullyQualifiedUrl : LPCWSTR -> (ptr uint16_t) *)
(* UrlContext : ULONGLONG -> uint64_t *)
(* 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 ("HttpAddUrlToUrlGroup" http-add-url-to-url-group :convention :stdcall) :uint32
  (url-group-id :uint64)   ; ULONGLONG
  (p-fully-qualified-url (:string :encoding :utf-16le))   ; LPCWSTR
  (url-context :uint64)   ; ULONGLONG
  (reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpAddUrlToUrlGroup = Win32::API::More->new('HTTPAPI',
    'DWORD HttpAddUrlToUrlGroup(UINT64 UrlGroupId, LPCWSTR pFullyQualifiedUrl, UINT64 UrlContext, DWORD Reserved)');
# my $ret = $HttpAddUrlToUrlGroup->Call($UrlGroupId, $pFullyQualifiedUrl, $UrlContext, $Reserved);
# UrlGroupId : ULONGLONG -> UINT64
# pFullyQualifiedUrl : LPCWSTR -> LPCWSTR
# UrlContext : ULONGLONG -> UINT64
# Reserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目