httpQueryUrlGroupProperty 函数 (http.h)

项目
08/24/2023

HttpQueryUrlGroupProperty 函数查询指定 URL 组上的属性。

语法

HTTPAPI_LINKAGE ULONG HttpQueryUrlGroupProperty(
  [in]            HTTP_URL_GROUP_ID    UrlGroupId,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [out, optional] PULONG               ReturnLength
);

parameters

[in] UrlGroupId

为其返回属性设置的 URL 组的 ID。

[in] Property

描述所查询的属性类型的 HTTP_SERVER_PROPERTY 枚举的成员。可以是以下位置之一：

属性	含义
HttpServerAuthenticationProperty	查询已启用的服务器端身份验证方案。
HttpServerTimeoutsProperty	查询 URL 组连接超时限制。
HttpServerStateProperty	查询 URL 组的当前状态。状态可以是启用或禁用。
HttpServerQosProperty	此值映射到 QosType 设置为 HttpQosSettingTypeBandwidth 或 HttpQosSettingTypeConnectionLimit 的泛型HTTP_QOS_SETTING_INFO结构。如果 HttpQosSettingTypeBandwidth，则查询 URL 组的带宽限制。如果 HttpQosSettingTypeConnectionLimit，则随时查询为 URL 组提供的最大未完成连接数。
HttpServerChannelBindProperty	(CBT) 属性查询通道绑定令牌。

[out] PropertyInformation

指向接收属性信息的缓冲区的指针。

pPropertyInformation 基于查询的属性指向以下属性信息结构之一。

属性	结构
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerChannelBindProperty	HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

pPropertyInformation 参数指向的缓冲区的长度（以字节为单位）。

[out, optional] ReturnLength

pPropertyInformation 缓冲区中返回的大小（以字节为单位）。

如果输出缓冲区太小，调用将失败，返回值为 ERROR_MORE_DATA。 pReturnLength 指向的值可用于确定调用成功所需的最小缓冲区长度。

返回值

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

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

值	含义
ERROR_INVALID_PARAMETER	URL 组不支持 Property 参数中指定的属性类型。 UrlGroupId 参数不标识有效的服务器 URL 组。 pPropertyInformation 参数为 NULL。 PropertyInformationLength 参数为零。应用程序没有查询 URL 组属性的权限。只有创建 URL 组的应用程序才能查询属性。
ERROR_MORE_DATA	pPropertyInformation 参数指向的缓冲区的大小（以字节为单位）太小，无法接收属性信息。再次调用函数，缓冲区的大小至少与退出时 pReturnLength 指向的大小一样大。

值

含义

ERROR_INVALID_PARAMETER

URL 组不支持 Property 参数中指定的属性类型。

UrlGroupId 参数不标识有效的服务器 URL 组。

pPropertyInformation 参数为 NULL。

PropertyInformationLength 参数为零。

应用程序没有查询 URL 组属性的权限。只有创建 URL 组的应用程序才能查询属性。

ERROR_MORE_DATA

pPropertyInformation 参数指向的缓冲区的大小（以字节为单位）太小，无法接收属性信息。再次调用函数，缓冲区的大小至少与退出时 pReturnLength 指向的大小一样大。

注解

不支持查询 HttpServerLoggingProperty 。

要求


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