Функция 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
);

Параметры

[in] UrlGroupId

Идентификатор группы URL-адресов, для которой возвращается параметр свойства.

[in] Property

Член перечисления HTTP_SERVER_PROPERTY , описывающий запрашиваемый тип свойства. Оно может быть одним из следующих.

Свойство	Значение
HttpServerAuthenticationProperty	Запрашивает включенные схемы проверки подлинности на стороне сервера.
HttpServerTimeoutsProperty	Запрашивает ограничения времени ожидания подключения группы URL-адресов.
HttpServerStateProperty	Запрашивает текущее состояние группы URL-адресов. Состояние можно включить или отключить.
HttpServerQosProperty	Это значение сопоставляется с универсальной структурой HTTP_QOS_SETTING_INFO, для параметра QosType задано значение HttpQosSettingTypeBandwidth или HttpQosSettingTypeConnectionLimit. Если 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	Тип свойства, указанный в параметре Property, не поддерживается для групп URL-адресов. Параметр UrlGroupId не определяет допустимую группу URL-адресов сервера. Параметр pPropertyInformation имеет значение NULL. Параметр PropertyInformationLength равен нулю. Приложение не имеет разрешения на запрос свойств группы URL-адресов. Только приложение, создающее группу URL-адресов, может запрашивать свойства.
ERROR_MORE_DATA	Размер (в байтах) буфера, на который указывает параметр pPropertyInformation , слишком мал для получения сведений о свойстве. Снова вызовите функцию с буфером, размером не ниже размера, на который указывает pReturnLength при выходе.

Значение

ERROR_INVALID_PARAMETER

Тип свойства, указанный в параметре Property, не поддерживается для групп URL-адресов.

Параметр UrlGroupId не определяет допустимую группу URL-адресов сервера.

Параметр pPropertyInformation имеет значение NULL.

Параметр PropertyInformationLength равен нулю.

Приложение не имеет разрешения на запрос свойств группы URL-адресов. Только приложение, создающее группу URL-адресов, может запрашивать свойства.

ERROR_MORE_DATA

Размер (в байтах) буфера, на который указывает параметр pPropertyInformation , слишком мал для получения сведений о свойстве. Снова вызовите функцию с буфером, размером не ниже размера, на который указывает pReturnLength при выходе.

Требования


Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	http.h
Библиотека	Httpapi.lib
DLL	Httpapi.dll