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

Статья
08/24/2023

Функция HttpSetRequestQueueProperty задает новое свойство или изменяет существующее свойство в очереди запросов, определяемой указанным дескриптором.

Синтаксис

HTTPAPI_LINKAGE ULONG HttpSetRequestQueueProperty(
  [in] HANDLE               RequestQueueHandle,
  [in] HTTP_SERVER_PROPERTY Property,
  [in] PVOID                PropertyInformation,
  [in] ULONG                PropertyInformationLength,
  [in] ULONG                Reserved1,
  [in] PVOID                Reserved2
);

Параметры

[in] RequestQueueHandle

Дескриптор очереди запросов, для которой задано свойство. Создается очередь запроса, и ее дескриптор возвращается вызовом функции HttpCreateRequestQueue .

[in] Property

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

Свойство	Значение
HttpServer503VerbosityProperty	Изменяет или задает текущий уровень детализации в 503 ответах, созданных для очереди запросов.
HttpServerQueueLengthProperty	Изменяет или задает ограничение на количество невыполненных запросов в очереди запросов.
HttpServerStateProperty	Изменяет или задает состояние очереди запросов. Состояние должно быть активным или неактивным.

[in] PropertyInformation

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

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

Свойство	Тип конфигурации
HttpServerStateProperty	Перечисление HTTP_ENABLED_STATE
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	Перечисление HTTP_503_RESPONSE_VERBOSITY

[in] PropertyInformationLength

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

[in] Reserved1

Зарезервировано. Должен равняться нулю.

[in] Reserved2

Зарезервировано. Должно иметь значение NULL.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Параметр Reserved не равен нулю или параметр pReserved не равен NULL. Тип свойства, указанный в параметре Property, не поддерживается для очередей запросов. Параметр pPropertyInformation имеет значение NULL. Параметр PropertyInformationLength равен нулю. Приложение не имеет разрешения на задание свойств в очереди запросов. Только приложение, создающее очередь запросов, может задавать свойства.
ERROR_NOT_SUPPORTED	Дескриптор очереди запросов — это дескриптор HTTP версии 1.0. Управление свойствами поддерживается только в очередях запросов HTTP версии 2.0 или более поздней.

Значение

ERROR_INVALID_PARAMETER

Параметр Reserved не равен нулю или параметр pReserved не равен NULL.

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

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

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

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

ERROR_NOT_SUPPORTED

Дескриптор очереди запросов — это дескриптор HTTP версии 1.0. Управление свойствами поддерживается только в очередях запросов HTTP версии 2.0 или более поздней.

Требования

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

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

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

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpQueryRequestQueueProperty

HttpShutdownRequestQueue

Поделиться через