HttpCreateUrlGroup 関数 (http.h)

  • [アーティクル]

HttpCreateUrlGroup 関数は、指定されたサーバー セッションの下に URL グループを作成します。

構文

HTTPAPI_LINKAGE ULONG HttpCreateUrlGroup(
  [in]  HTTP_SERVER_SESSION_ID ServerSessionId,
  [out] PHTTP_URL_GROUP_ID     pUrlGroupId,
  [in]  ULONG                  Reserved
);

パラメーター

[in] ServerSessionId

URL グループが作成されるサーバー セッションの識別子。

[out] pUrlGroupId

URL グループの ID を受け取る変数へのポインター。

[in] Reserved

予約済み。 ゼロを指定してください。

戻り値

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

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

値 説明
ERROR_INVALID_PARAMETER
 ServerSessionId パラメーターは、既存ではないサーバー セッションを示します。

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

予約済みパラメーターは 0 以外です。

解説

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

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

URL グループと要求キューの関連付けは動的です。 サーバー セッションまたは URL グループが削除されるまで、サーバー セッションとの関連付けを変更することはできません。 サーバー セッションが削除されると、関連付けられているすべての URL グループも自動的に閉じられます。

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

アプリケーションでは、次の理由により、複数の URL グループが作成される場合があります。

  • リッスンしている URL ネーム スペースの異なる部分に対して個別の構成を設定する。
  • リッスンしている URL ネーム スペースの異なる部分に対して個別の要求キューを設定する。

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

HTTP Server API では、URL グループでの非同期 I/O はサポートされていません。

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

URL グループは、作成元のサーバー セッションと同じバージョンで作成されます。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー http.h
Library Httpapi.lib
[DLL] Httpapi.dll

関連項目

HTTP Server API バージョン 2.0 関数

HttpAddUrlToUrlGroup

HttpCloseUrlGroup

HttpQueryUrlGroupProperty

HttpRemoveUrlFromUrlGroup

HttpSetUrlGroupProperty