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

Статья
08/24/2023

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

Синтаксис

HTTPAPI_LINKAGE ULONG HttpQueryRequestQueueProperty(
                  HANDLE               RequestQueueHandle,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [in]            ULONG                Reserved1,
  [out, optional] PULONG               ReturnLength,
  [in]            PVOID                Reserved2
);

Параметры

RequestQueueHandle

[in] Property

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

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

[out] PropertyInformation

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

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

Свойство	Значение
HttpServerStateProperty	HTTP_ENABLED_STATE (элемент перечисления)
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	HTTP_503_RESPONSE_VERBOSITY (элемент перечисления)

[in] PropertyInformationLength

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

[in] Reserved1

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

[out, optional] ReturnLength

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

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

[in] Reserved2

Этот параметр зарезервирован и должен иметь значение NULL.

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

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

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

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

Значение

ERROR_INVALID_PARAMETER

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

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

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

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

Приложение не имеет разрешения на открытие очереди запросов.

ERROR_MORE_DATA

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

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

HttpSetRequestQueueProperty

HttpShutdownRequestQueue

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