Skip to content

Latest commit

 

History

History
242 lines (190 loc) · 7.14 KB

nf-http-httpqueryurlgroupproperty.md

File metadata and controls

242 lines (190 loc) · 7.14 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:http.HttpQueryUrlGroupProperty
HttpQueryUrlGroupProperty function (http.h)
Queries a property on the specified URL Group.
HttpQueryUrlGroupProperty
HttpQueryUrlGroupProperty function [HTTP]
HttpServerAuthenticationProperty
HttpServerChannelBindProperty
HttpServerQosProperty
HttpServerStateProperty
HttpServerTimeoutsProperty
http.httpqueryurlgroupproperty
http/HttpQueryUrlGroupProperty
http\httpqueryurlgroupproperty.htm
http
f3e8fde0-5a78-46aa-8c6c-cea957d12356
12/05/2018
HttpQueryUrlGroupProperty, HttpQueryUrlGroupProperty function [HTTP], HttpServerAuthenticationProperty, HttpServerChannelBindProperty, HttpServerQosProperty, HttpServerStateProperty, HttpServerTimeoutsProperty, http.httpqueryurlgroupproperty, http/HttpQueryUrlGroupProperty
http.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Httpapi.lib
Httpapi.dll
Windows
19H1
HttpQueryUrlGroupProperty
http/HttpQueryUrlGroupProperty
c++
APIRef
kbSyntax
DllExport
Httpapi.dll
HttpQueryUrlGroupProperty

HttpQueryUrlGroupProperty function

-description

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

-parameters

-param UrlGroupId [in]

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

-param Property [in]

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.

-param PropertyInformation [out]

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

-param PropertyInformationLength [in]

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

-param ReturnLength [out, optional]

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.

-returns

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.

-remarks

Querying the HttpServerLoggingProperty is not supported.

-see-also

HTTP Server API Version 2.0 Functions

HttpAddUrlToUrlGroup

HttpCloseUrlGroup

HttpCreateUrlGroup

HttpRemoveUrlFromUrlGroup

HttpSetUrlGroupProperty