ホーム › Networking.HttpServer › HttpCreateUrlGroup

HttpCreateUrlGroup

関数

サーバーセッションにURLグループを作成する。

DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD HttpCreateUrlGroup(
    ULONGLONG ServerSessionId,
    ULONGLONG* pUrlGroupId,
    DWORD Reserved   // optional
);

パラメーター

名前	型	方向	説明
ServerSessionId	ULONGLONG	in	URL Group を作成する対象のサーバーセッションの識別子。
pUrlGroupId	ULONGLONG*	out	URL Group の ID を受け取る変数へのポインター。
Reserved	DWORD	inoptional	予約済み。ゼロでなければなりません。

戻り値の型: DWORD

公式ドキュメント

指定されたサーバーセッションの下に URL Group を作成します。

戻り値

関数が成功した場合は NO_ERROR を返します。

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

値	意味
ERROR_INVALID_PARAMETER	ServerSessionId パラメーターが存在しないサーバーセッションを示しています。 pUrlGroupId パラメーターが null です。 Reserved パラメーターがゼロではありません。

値

意味

ERROR_INVALID_PARAMETER

ServerSessionId パラメーターが存在しないサーバーセッションを示しています。

pUrlGroupId パラメーターが null です。

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

解説(Remarks)

URL Group は、一連の URL に対する構成コンテナーです。これらはサーバーセッションの下に作成され、サーバーセッションの構成設定を継承します。URL Group に構成パラメーターが設定されると、サーバーセッションに設定された構成を上書きします。URL Group の構成設定の詳細については、HttpSetUrlGroupProperty を参照してください。

URL Group は作成された後、要求を受け取るためにリクエストキューと関連付ける必要があります。URL Group をリクエストキューに関連付けるには、アプリケーションは HttpServerBindingProperty プロパティを指定して HttpSetUrlGroupProperty を呼び出します。このプロパティが設定されていない場合、URL Group に一致する要求はリクエストキューに配信されず、HTTP Server API は 503 応答を生成します。

URL Group とリクエストキューの関連付けは動的です。サーバーセッションとの関連付けは、サーバーセッションまたは URL Group が削除されるまで変更できません。サーバーセッションが削除されると、関連付けられているすべての URL Group も自動的に閉じられます。

URL Group は最初は空のグループとして作成されます。URL は HttpAddUrlToUrlGroup を呼び出してグループに追加する必要があります。

アプリケーションは、次の理由により複数の URL Group を作成できます。

リッスンしている URL 名前空間の異なる部分に対して、個別の構成を設定するため。
リッスンしている URL 名前空間の異なる部分に対して、個別のリクエストキューを設定するため。

アプリケーションは、可能な限り URL をグループにまとめるべきです。そうしないと、パフォーマンスが低下し、システムのメモリ消費量の増加がスケーラビリティに影響します。

HTTP Server API は、URL Group に対する非同期 I/O をサポートしていません。

URL Group が不要になったとき、またはアプリケーションが終了する前に、HttpCloseUrlGroup を呼び出して URL Group を削除する必要があります。

URL Group は、それが作成される対象のサーバーセッションと同じバージョンで作成されます。

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

各言語での呼び出し定義

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

DWORD HttpCreateUrlGroup(
    ULONGLONG ServerSessionId,
    ULONGLONG* pUrlGroupId,
    DWORD Reserved   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpCreateUrlGroup(
    ulong ServerSessionId,   // ULONGLONG
    out ulong pUrlGroupId,   // ULONGLONG* out
    uint Reserved   // DWORD optional
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpCreateUrlGroup(
    ServerSessionId As ULong,   ' ULONGLONG
    <Out> ByRef pUrlGroupId As ULong,   ' ULONGLONG* out
    Reserved As UInteger   ' DWORD optional
) As UInteger
End Function

' ServerSessionId : ULONGLONG
' pUrlGroupId : ULONGLONG* out
' Reserved : DWORD optional
Declare PtrSafe Function HttpCreateUrlGroup Lib "httpapi" ( _
    ByVal ServerSessionId As LongLong, _
    ByRef pUrlGroupId 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

HttpCreateUrlGroup = ctypes.windll.httpapi.HttpCreateUrlGroup
HttpCreateUrlGroup.restype = wintypes.DWORD
HttpCreateUrlGroup.argtypes = [
    ctypes.c_ulonglong,  # ServerSessionId : ULONGLONG
    ctypes.POINTER(ctypes.c_ulonglong),  # pUrlGroupId : ULONGLONG* out
    wintypes.DWORD,  # Reserved : DWORD optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpCreateUrlGroup = Fiddle::Function.new(
  lib['HttpCreateUrlGroup'],
  [
    -Fiddle::TYPE_LONG_LONG,  # ServerSessionId : ULONGLONG
    Fiddle::TYPE_VOIDP,  # pUrlGroupId : ULONGLONG* out
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpCreateUrlGroup(
        ServerSessionId: u64,  // ULONGLONG
        pUrlGroupId: *mut u64,  // ULONGLONG* out
        Reserved: u32  // DWORD optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpCreateUrlGroup(ulong ServerSessionId, out ulong pUrlGroupId, uint Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpCreateUrlGroup' -Namespace Win32 -PassThru
# $api::HttpCreateUrlGroup(ServerSessionId, pUrlGroupId, Reserved)

#uselib "HTTPAPI.dll"
#func global HttpCreateUrlGroup "HttpCreateUrlGroup" sptr, sptr, sptr
; HttpCreateUrlGroup ServerSessionId, varptr(pUrlGroupId), Reserved   ; 戻り値は stat
; ServerSessionId : ULONGLONG -> "sptr"
; pUrlGroupId : ULONGLONG* out -> "sptr"
; Reserved : DWORD optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpCreateUrlGroup "HttpCreateUrlGroup" int64, var, int
; res = HttpCreateUrlGroup(ServerSessionId, pUrlGroupId, Reserved)
; ServerSessionId : ULONGLONG -> "int64"
; pUrlGroupId : ULONGLONG* out -> "var"
; Reserved : DWORD optional -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "HTTPAPI.dll"
#cfunc global HttpCreateUrlGroup "HttpCreateUrlGroup" int64, sptr, int
; res = HttpCreateUrlGroup(ServerSessionId, varptr(pUrlGroupId), Reserved)
; ServerSessionId : ULONGLONG -> "int64"
; pUrlGroupId : ULONGLONG* out -> "sptr"
; Reserved : DWORD optional -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。