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

Статья
08/24/2023

Функция HttpSetServerSessionProperty задает новое свойство сеанса сервера или изменяет существующее свойство в указанном сеансе сервера.

Синтаксис

HTTPAPI_LINKAGE ULONG HttpSetServerSessionProperty(
  [in] HTTP_SERVER_SESSION_ID ServerSessionId,
  [in] HTTP_SERVER_PROPERTY   Property,
  [in] PVOID                  PropertyInformation,
  [in] ULONG                  PropertyInformationLength
);

Параметры

[in] ServerSessionId

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

[in] Property

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

Свойство	Значение
HttpServerStateProperty	Изменяет или задает состояние сеанса сервера. Состояние можно включить или отключить; состояние по умолчанию включено.
HttpServerTimeoutsProperty	Изменяет или задает ограничения времени ожидания подключения к сеансу сервера.
HttpServerQosProperty	Изменяет или задает регулирование пропускной способности для сеанса сервера. По умолчанию API HTTP-сервера не ограничивает пропускную способность. Примечание Это значение сопоставляется с универсальной структурой HTTP_QOS_SETTING_INFO , для параметра QosTypeзадано значение HttpQosSettingTypeBandwidth.
HttpServerLoggingProperty	Включает или отключает ведение журнала для сеанса сервера. Это свойство задает только централизованное ведение журнала W3C и централизованное двоичное ведение журнала. По умолчанию ведение журнала не включено.
HttpServerAuthenticationProperty	Включает проверку подлинности на стороне сервера в режиме ядра для схем проверки подлинности Basic, NTLM, Negotiate и Digest.
HttpServerExtendedAuthenticationProperty	Включает проверку подлинности на стороне сервера в режиме ядра для схемы проверки подлинности Kerberos.
HttpServerChannelBindProperty	Включает проверку подлинности на стороне сервера, использующего маркер привязки канала (CBT).

[in] PropertyInformation

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

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

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

[in] PropertyInformationLength

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

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

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

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

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

Значение

ERROR_INVALID_PARAMETER

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

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

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

Параметр ServerSessionId не содержит допустимый сеанс сервера.

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

Сеансы сервера — это контейнеры конфигурации верхнего уровня для данных конфигурации, которые применяются ко всем созданным в них группам URL-адресов. Сеанс сервера создается с помощью HttpCreateServerSession.

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

Требования

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