Función HttpSetRequestQueueProperty (http.h)

Artículo
02/26/2024

La función HttpSetRequestQueueProperty establece una nueva propiedad o modifica una propiedad existente en la cola de solicitudes identificada por el identificador especificado.

Sintaxis

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

Parámetros

[in] RequestQueueHandle

Identificador de la cola de solicitudes en la que se establece la propiedad . Se crea una cola de solicitudes y su identificador devuelto por una llamada a la función HttpCreateRequestQueue .

[in] Property

Miembro de la enumeración HTTP_SERVER_PROPERTY que describe el tipo de propiedad establecido. Debe ser una de las siguientes:

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

[in] PropertyInformation

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

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

Propiedad	Tipo de configuración
HttpServerStateProperty	enumeración HTTP_ENABLED_STATE
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	enumeración HTTP_503_RESPONSE_VERBOSITY

[in] PropertyInformationLength

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

[in] Reserved1

Reservado. Debe ser cero.

[in] Reserved2

Reservado. 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 para las colas de solicitudes. El parámetro pPropertyInformation es NULL. El parámetro PropertyInformationLength es cero. La aplicación no tiene permiso para establecer propiedades en la cola de solicitudes. Solo la aplicación que creó la cola de solicitudes puede establecer las propiedades.
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 en las colas de solicitudes HTTP versión 2.0 o posteriores.

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 para las colas de solicitudes.

El parámetro pPropertyInformation es NULL.

El parámetro PropertyInformationLength es cero.

La aplicación no tiene permiso para establecer propiedades en la cola de solicitudes. Solo la aplicación que creó la cola de solicitudes puede establecer las propiedades.

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 en las colas de solicitudes HTTP versión 2.0 o posteriores.

Requisitos

Requisito	Value
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

HttpQueryRequestQueueProperty

HttpShutdownRequestQueue