Función HttpQueryRequestQueueProperty (http.h)

  • Artículo

La función HttpQueryRequestQueueProperty consulta una propiedad de la cola de solicitudes identificada por el identificador especificado.

Sintaxis

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
);

Parámetros

RequestQueueHandle

[in] Property

Miembro de la enumeración HTTP_SERVER_PROPERTY que describe el tipo de propiedad que se establece. Este puede ser uno de los siguientes:

Propiedad Significado
HttpServer503VerbosityProperty
 Consulta el nivel de detalle actual de 503 respuestas generadas para la cola de solicitudes.
HttpServerQueueLengthProperty
 Consulta el límite en el número de solicitudes pendientes en la cola de solicitudes.
HttpServerStateProperty
 Consulta el estado actual de la cola de solicitudes. El estado debe estar activo o inactivo.

[out] PropertyInformation

Puntero al búfer que recibe la información de la propiedad.

pPropertyInformation apunta a uno de los siguientes valores de información de propiedad en función de la propiedad establecida.

Propiedad Valor
HttpServerStateProperty HTTP_ENABLED_STATE (miembro de enumeración)
HttpServerQueueLengthProperty ULONG
HttpServer503VerbosityProperty HTTP_503_RESPONSE_VERBOSITY (miembro de enumeración)

[in] PropertyInformationLength

Longitud, en bytes, del búfer al que apunta el parámetro pPropertyInformation .

[in] Reserved1

Reservado. Debe ser cero.

[out, optional] ReturnLength

Número, en bytes, devuelto en el búfer pPropertyInformation si no es NULL.

Si el búfer de salida es demasiado pequeño, se produce un error en la llamada con un valor devuelto de ERROR_MORE_DATA. El valor al que apunta pReturnLength se puede usar para determinar la longitud mínima del búfer necesario para que la llamada se realice correctamente.

[in] Reserved2

Este parámetro está reservado y debe ser NULL.

Valor devuelto

Si la función se realiza correctamente, devuelve NO_ERROR.

Si se produce un error en la función, devuelve uno de los siguientes códigos de error.

Valor Significado
ERROR_INVALID_PARAMETER
 El parámetro Reserved no es cero o el parámetro pReserved no es NULL.

El tipo de propiedad especificado en el parámetro Property no se admite en las colas de solicitudes.

El parámetro pPropertyInformation es NULL.

El parámetro PropertyInformationLength es cero.

La aplicación no tiene permiso para abrir la cola de solicitudes.
ERROR_MORE_DATA
 El tamaño, en bytes, del búfer al que apunta el parámetro pPropertyInformation es demasiado pequeño para recibir la información de propiedad. Vuelva a llamar a la función con un búfer al menos tan grande como el tamaño al que apunta pReturnLength al salir.
ERROR_NOT_SUPPORTED
 El identificador de la cola de solicitudes es un identificador http versión 1.0. La administración de propiedades solo se admite para las colas de solicitudes HTTP versión 2.0 y posteriores.

Requisitos

   
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado http.h
Library Httpapi.lib
Archivo DLL Httpapi.dll

Consulte también

Funciones de la API de servidor HTTP versión 2.0

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpSetRequestQueueProperty

HttpShutdownRequestQueue