HttpAddUrlToUrlGroup 関数 (http.h)

[アーティクル]
02/29/2024

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

この関数は、HTTP バージョン 1.0 HttpAddUrl 関数を置き換えます。

構文

HTTPAPI_LINKAGE ULONG HttpAddUrlToUrlGroup(
  [in]           HTTP_URL_GROUP_ID UrlGroupId,
  [in]           PCWSTR            pFullyQualifiedUrl,
  [in, optional] HTTP_URL_CONTEXT  UrlContext,
  [in]           ULONG             Reserved
);

パラメーター

[in] UrlGroupId

指定した URL の要求がルーティングされる URL グループのグループ ID。 URL グループは、 HttpCreateUrlGroup 関数によって作成されます。

[in] pFullyQualifiedUrl

登録する URL を識別する適切な形式の UrlPrefix 文字列を含む Unicode 文字列へのポインター。管理者として実行していない場合は、1024 より大きいポート番号を指定します。そうしないと、ERROR_ACCESS_DENIED エラーが発生する可能性があります。

[in, optional] UrlContext

この呼び出しに登録されている URL に関連付けられているコンテキスト。 URL コンテキストは、pFullyQualifiedUrl パラメーターで指定された URL で受信したすべての要求を使用して、HTTP_REQUEST構造体で返されます。

[in] Reserved

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

戻り値

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

関数が失敗すると、次のいずれかのエラーコードが返されます。

値	意味
ERROR_INVALID_PARAMETER	UrlGroupId が存在しません。予約済みパラメーターが 0 ではありません。アプリケーションには、グループに URL を追加するアクセス許可がありません。 URL グループを作成したアプリケーションのみが URL を追加できます。
ERROR_ACCESS_DENIED	呼び出し元のプロセスには、URL を登録するアクセス許可がありません。
ERROR_ALREADY_EXISTS	指定した URL が既存の登録と競合しています。

値

意味

ERROR_INVALID_PARAMETER

UrlGroupId が存在しません。

予約済みパラメーターが 0 ではありません。

アプリケーションには、グループに URL を追加するアクセス許可がありません。 URL グループを作成したアプリケーションのみが URL を追加できます。

ERROR_ACCESS_DENIED

呼び出し元のプロセスには、URL を登録するアクセス許可がありません。

ERROR_ALREADY_EXISTS

指定した URL が既存の登録と競合しています。

注釈

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

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

要件

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