HttpRemoveUrlFromUrlGroup 関数 (http.h)
HttpRemoveUrlFromUrlGroup 関数は、URL グループ ID で識別されるグループから指定された URL を削除します。 この関数は、グループから URL の 1 つまたはすべてを削除します。
この関数は、HTTP バージョン 1.0 HttpRemoveUrl 関数に 置き換えられます。
構文
HTTPAPI_LINKAGE ULONG HttpRemoveUrlFromUrlGroup(
[in] HTTP_URL_GROUP_ID UrlGroupId,
[in] PCWSTR pFullyQualifiedUrl,
[in] ULONG Flags
);
パラメーター
[in] UrlGroupId
pFullyQualifiedUrl で指定された URL が削除される URL グループの ID。
[in] pFullyQualifiedUrl
削除する URL を識別する適切な形式の UrlPrefix 文字列 を含む Unicode 文字列へのポインター。
HTTP_URL_FLAG_REMOVE_ALLを Flags パラメーターに渡すと、UrlGroupId で識別された URL グループのすべての既存の URL 登録がグループから削除されます。 この場合、 pFullyQualifiedUrl はNULL である必要があります。
[in] Flags
削除された URL を修飾する URL フラグ。 これには、次のいずれかのフラグを指定できます。
URL フラグ | 意味 |
---|---|
|
URL グループに現在登録されているすべての URL を削除します。 |
戻り値
関数が成功すると、NO_ERRORが返されます。
関数が失敗した場合は、次のいずれかのエラー コードが返されます。
値 | 意味 |
---|---|
|
URL グループが存在しません。
Flags パラメーターには、無効なフラグの組み合わせが含まれています。 HTTP_URL_FLAG_REMOVE_ALL フラグが設定され、 pFullyQualifiedUrl パラメーターが NULL に設定されていません。 アプリケーションには、グループから URL を削除するアクセス許可がありません。 URL グループを作成したアプリケーションのみが URL を削除できます。 |
|
呼び出し元のプロセスには、URL を登録解除するアクセス許可がありません。 |
|
指定した URL が URL グループに登録されていません。 |
注釈
HTTP Server API では、バージョン 1.0 の URL 登録を使用する既存のアプリケーションがサポートされていますが、HTTP Server API を使用した新しい開発では HttpRemoveUrlFromUrlGroup を使用する必要があります。 HttpRemoveUrl は使用しないでください。
アプリケーションでは、 HTTPAddUrlToUrlGroup によってグループに追加された URL は、URL が不要になったときに削除する必要があります。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | http.h |
Library | Httpapi.lib |
[DLL] | Httpapi.dll |