HttpQueryUrlGroupProperty function (http.h)

Article
10/13/2021

The HttpQueryUrlGroupProperty function queries a property on the specified URL Group.

Syntax

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

The ID of the URL Group for which the property setting is returned.

[in] Property

A member of the HTTP_SERVER_PROPERTY enumeration that describes the property type that is queried. This can be one of the following:

Property	Meaning
HttpServerAuthenticationProperty	Queries the enabled server-side authentication schemes.
HttpServerTimeoutsProperty	Queries the URL Group connection timeout limits.
HttpServerStateProperty	Queries the current state of the URL Group. The state can be either enabled or disabled.
HttpServerQosProperty	This value maps to the generic HTTP_QOS_SETTING_INFO structure with QosType set to either HttpQosSettingTypeBandwidth or HttpQosSettingTypeConnectionLimit. If HttpQosSettingTypeBandwidth, queries the bandwidth throttling for the URL Group. If HttpQosSettingTypeConnectionLimit, queries the maximum number of outstanding connections served for a URL group at any time.
HttpServerChannelBindProperty	Queries the channel binding token (CBT) properties.

[out] PropertyInformation

A pointer to the buffer that receives the property information.

pPropertyInformation points to one of the following property information structures based on the property that is queried.

Property	Structure
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

The length, in bytes, of the buffer pointed to by the pPropertyInformation parameter.

[out, optional] ReturnLength

The size, in bytes, returned in the pPropertyInformation buffer.

If the output buffer is too small, the call fails with a return value of ERROR_MORE_DATA. The value pointed to by pReturnLength can be used to determine the minimum length of the buffer required for the call to succeed.

Return value

If the function succeeds, it returns NO_ERROR.

If the function fails, it returns one of the following error codes.

Value	Meaning
ERROR_INVALID_PARAMETER	The property type specified in the Property parameter is not supported for URL Groups. The UrlGroupId parameter does not identify a valid server URL Group. The pPropertyInformation parameter is NULL. The PropertyInformationLength parameter is zero. The application does not have permission to query the URL Group properties. Only the application that created the URL Group can query the properties.
ERROR_MORE_DATA	The size, in bytes, of the buffer pointed to by the pPropertyInformation parameter is too small to receive the property information. Call the function again with a buffer at least as large as the size pointed to by pReturnLength on exit.

Value

Meaning

ERROR_INVALID_PARAMETER

The property type specified in the Property parameter is not supported for URL Groups.

The UrlGroupId parameter does not identify a valid server URL Group.

The pPropertyInformation parameter is NULL.

The PropertyInformationLength parameter is zero.

The application does not have permission to query the URL Group properties. Only the application that created the URL Group can query the properties.

ERROR_MORE_DATA

The size, in bytes, of the buffer pointed to by the pPropertyInformation parameter is too small to receive the property information. Call the function again with a buffer at least as large as the size pointed to by pReturnLength on exit.

Remarks

Querying the HttpServerLoggingProperty is not supported.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	http.h
Library	Httpapi.lib
DLL	Httpapi.dll