Функция HttpQueryServerSessionProperty (http.h)

Функция HttpQueryServerSessionProperty запрашивает свойство сервера в указанном сеансе сервера.

Синтаксис

HTTPAPI_LINKAGE ULONG HttpQueryServerSessionProperty(
  [in]            HTTP_SERVER_SESSION_ID ServerSessionId,
  [in]            HTTP_SERVER_PROPERTY   Property,
  [out]           PVOID                  PropertyInformation,
  [in]            ULONG                  PropertyInformationLength,
  [out, optional] PULONG                 ReturnLength
);

Параметры

[in] ServerSessionId

Сеанс сервера, для которого возвращается параметр свойства.

[in] Property

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

Свойство	Значение
HttpServerStateProperty	Запрашивает текущее состояние сеанса сервера.
HttpServerTimeoutsProperty	Запрашивает ограничения времени ожидания подключения к сеансу сервера.
HttpServerQosProperty	Запрашивает регулирование пропускной способности для сеанса сервера. По умолчанию API HTTP-сервера не ограничивает пропускную способность.
HttpServerAuthenticationProperty	Запрашивает проверку подлинности на стороне сервера в режиме ядра для схем проверки подлинности Basic, NTLM, Negotiate и Digest.
HttpServerChannelBindProperty	Запрашивает свойства токена привязки канала (CBT).

[out] PropertyInformation

Указатель на буфер, получающий данные свойства.

pPropertyInformation указывает на одну из следующих структур данных свойств на основе заданного свойства.

Свойство	Структура
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerChannelBindProperty	HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

Длина (в байтах) буфера, на который указывает параметр pPropertyInformation .

[out, optional] ReturnLength

Число в байтах, возвращаемое в буфере pPropertyInformation .

Если выходной буфер слишком мал, вызов завершается ошибкой с возвращаемым значением ERROR_MORE_DATA. Значение, указываемое pReturnLength , можно использовать для определения минимальной длины буфера, необходимой для успешного вызова.

Возвращаемое значение

Если функция выполняется успешно, она возвращает NO_ERROR

Если функция завершается сбоем, она возвращает один из следующих кодов ошибок.

Значение	Значение
ERROR_INVALID_PARAMETER	Тип свойства, указанный в параметре Property, не поддерживается для сеансов сервера. Параметр ServerSessionId не содержит допустимый сеанс сервера. Параметр pPropertyInformation имеет значение NULL. Параметр PropertyInformationLength равен нулю. Приложение не имеет разрешения на запрос свойств сеанса сервера. Только приложение, создающее сеанс сервера, может запрашивать свойства.
ERROR_MORE_DATA	Размер (в байтах) буфера, на который указывает параметр pPropertyInformation , слишком мал для получения данных свойства. При выходе снова вызовите функцию с буфером, размером не ниже размера, на который указывает pReturnLength при выходе.

Комментарии

Запрос httpServerLoggingProperty не поддерживается.

Параметр pPropertyInformation указывает на структуру конфигурации для запрашиваемого типа свойства. Параметр PropertyInformationLength указывает размер (в байтах) структуры конфигурации. Например, при запросе HttpServerTimeoutsProperty параметр pPropertyInformation должен указывать на буфер, размер по крайней мере размер HTTP_TIMEOUT_LIMIT_INFO структуры.

Чтобы указать свойство HttpServerQosProperty в параметре pPropertyInformation , задайте для параметра QosType значение HttpQosSettingTypeBandwidth внутри структуры HTTP_QOS_SETTING_INFO и передайте указатель на эту структуру в параметре .

Требования

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

См. также раздел

Функции API HTTP-сервера версии 2.0

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty