HttpQueryRequestQueueProperty function

The HttpQueryRequestQueueProperty function queries a property of the request queue identified by the specified handle.

Syntax

HTTPAPI_LINKAGE ULONG HttpQueryRequestQueueProperty(
  HANDLE               RequestQueueHandle,
  HTTP_SERVER_PROPERTY Property,
  PVOID                PropertyInformation,
  ULONG                PropertyInformationLength,
  ULONG                Reserved1,
  PULONG               ReturnLength,
  PVOID                Reserved2
);

Parameters

RequestQueueHandle

Property

A member of the HTTP_SERVER_PROPERTY enumeration that describes the property type that is set. This can be one of the following:

Property Meaning
HttpServer503VerbosityProperty
Queries the current verbosity level of 503 responses generated for the requests queue.
HttpServerQueueLengthProperty
Queries the limit on the number of outstanding requests in the request queue.
HttpServerStateProperty
Queries the current state of the request queue. The state must be either active or inactive.

PropertyInformation

A pointer to the buffer that receives the property information.

pPropertyInformation points to one of the following property information values based on the property that is set.

Property Value
HttpServerStateProperty HTTP_ENABLED_STATE (enumeration member)
HttpServerQueueLengthProperty ULONG
HttpServer503VerbosityProperty HTTP_503_RESPONSE_VERBOSITY (enumeration member)

PropertyInformationLength

The length, in bytes, of the buffer pointed to by the pPropertyInformation parameter.

Reserved1

Reserved. Must be zero.

ReturnLength

The number, in bytes, returned in the pPropertyInformation buffer if not NULL.

If the output buffer is too small, the call fails with a return value of ERROR_MORE_DATA. The value pointed to by pReturnLength can be used to determine the minimum length of the buffer required for the call to succeed.

Reserved2

This parameter is reserved and must be NULL.

Return Value

If the function succeeds, it returns NO_ERROR.

If the function fails, it returns one of the following error codes.

Value Meaning
ERROR_INVALID_PARAMETER
The Reserved parameter is not zero or the pReserved parameter is not NULL.

The property type specified in the Property parameter is not supported on request queues.

The pPropertyInformation parameter is NULL.

The PropertyInformationLength parameter is zero.

The application does not have permission to open the request queue.

ERROR_MORE_DATA
The size, in bytes, of the buffer pointed to by the pPropertyInformation parameter is too small to receive the property information. Call the function again with a buffer at least as large as the size pointed to by pReturnLength on exit.
ERROR_NOT_SUPPORTED
The handle to the request queue is an HTTP version 1.0 handle. Property management is only supported for HTTP version 2.0 and later request queues.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header http.h
Library Httpapi.lib
DLL Httpapi.dll

See Also

HTTP Server API Version 2.0 Functions

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpSetRequestQueueProperty

HttpShutdownRequestQueue