httpRemoveUrlFromUrlGroup 函数 (http.h)

项目
08/24/2023

HttpRemoveUrlFromUrlGroup 函数从 URL 组 ID 标识的组中删除指定的 URL。此函数从组中删除一个或全部 URL。

此函数替换 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

指向 Unicode 字符串的指针，该字符串包含格式正确的 UrlPrefix 字符串，该字符串标识要删除的 URL。

在 Flags 参数中传递HTTP_URL_FLAG_REMOVE_ALL时，将从组中删除 UrlGroupId 中标识的 URL 组的所有现有 URL 注册。在这种情况下， pFullyQualifiedUrl 必须为 NULL。

[in] Flags

URL 标志限定已删除的 URL。这可以是以下标志之一：

URL 标志	含义
HTTP_URL_FLAG_REMOVE_ALL	删除当前注册到 URL 组的所有 URL。

返回值

如果函数成功，则返回NO_ERROR。

如果该函数失败，它将返回以下错误代码之一。

值	含义
ERROR_INVALID_PARAMETER	URL 组不存在。 Flags 参数包含无效的标志组合。 HTTP_URL_FLAG_REMOVE_ALL标志已设置， pFullyQualifiedUrl 参数未设置为 NULL。应用程序无权从组中删除 URL。只有创建 URL 组的应用程序才能删除 URL。
ERROR_ACCESS_DENIED	调用进程无权取消注册 URL。
ERROR_FILE_NOT_FOUND	指定的 URL 未注册到 URL 组。

值

含义

ERROR_INVALID_PARAMETER

URL 组不存在。

Flags 参数包含无效的标志组合。

HTTP_URL_FLAG_REMOVE_ALL标志已设置， pFullyQualifiedUrl 参数未设置为 NULL。

应用程序无权从组中删除 URL。只有创建 URL 组的应用程序才能删除 URL。

ERROR_ACCESS_DENIED

调用进程无权取消注册 URL。

ERROR_FILE_NOT_FOUND

指定的 URL 未注册到 URL 组。

注解

HTTP 服务器 API 支持使用 1.0 版 URL 注册的现有应用程序，但是，使用 HTTP 服务器 API 的新开发应使用 HttpRemoveUrlFromUrlGroup;请勿使用 HttpRemoveUrl。

当不再需要该 URL 时，应用程序应删除 HttpAddUrlToUrlGroup 添加到组中的 URL。

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 [仅限桌面应用]
目标平台	Windows
标头	http.h
Library	Httpapi.lib
DLL	Httpapi.dll