httpAddUrlToUrlGroup 函数 (http.h)

项目
03/14/2023

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

指向 Unicode 字符串的指针，该字符串包含格式正确的 UrlPrefix 字符串，该字符串标识要注册的 URL。如果未以管理员身份运行，请指定大于 1024 的端口号，否则可能会收到ERROR_ACCESS_DENIED错误。

[in, optional] UrlContext

与此调用中注册的 URL 关联的上下文。 URL 上下文在 HTTP_REQUEST 结构中返回，其中包含 在 pFullyQualifiedUrl 参数中指定的 URL 上收到的每个请求。

[in] Reserved

保留。必须为零。

返回值

如果函数成功，则返回 NO_ERROR

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

值	含义
ERROR_INVALID_PARAMETER	UrlGroupId 不存在。 Reserved 参数不为零。应用程序无权将 URL 添加到组。只有创建 URL 组的应用程序才能添加 URL。
ERROR_ACCESS_DENIED	调用进程没有注册 URL 的权限。
ERROR_ALREADY_EXISTS	指定的 URL 与现有注册冲突。

值

含义

ERROR_INVALID_PARAMETER

UrlGroupId 不存在。

Reserved 参数不为零。

应用程序无权将 URL 添加到组。只有创建 URL 组的应用程序才能添加 URL。

ERROR_ACCESS_DENIED

调用进程没有注册 URL 的权限。

ERROR_ALREADY_EXISTS

指定的 URL 与现有注册冲突。

注解

HTTP 服务器 API 支持使用 1.0 版 URL 注册的现有应用程序，但是，使用 HTTP 服务器 API 进行的新开发应使用 HttpAddUrlToUrlGroup;不应使用 HttpAddUrl 。

应用程序可以使用对 HttpAddUrlToUrlGroup 的重复调用将多个 URL 添加到 URL 组。与指定 URL 匹配的请求将路由到与 URL 组关联的请求队列。有关 HTTP 服务器 API 如何将请求 URL 与已注册的 URL 匹配的详细信息，请参阅 UrlPrefix 字符串。

要求

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