Função HttpSetRequestQueueProperty (http.h)

Artigo
02/26/2024

A função HttpSetRequestQueueProperty define uma nova propriedade ou modifica uma propriedade existente na fila de solicitação identificada pelo identificador especificado.

Sintaxe

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

O identificador para a fila de solicitação na qual a propriedade está definida. Uma fila de solicitação é criada e seu identificador retornado por uma chamada para a função HttpCreateRequestQueue .

[in] Property

Um membro da enumeração HTTP_SERVER_PROPERTY que descreve o tipo de propriedade definido. Este deve ser um dos seguintes:

Propriedade	Significado
HttpServer503VerbosityProperty	Modifica ou define o nível de detalhamento atual de 503 respostas geradas para a fila de solicitações.
HttpServerQueueLengthProperty	Modifica ou define o limite do número de solicitações pendentes na fila de solicitações.
HttpServerStateProperty	Modifica ou define o estado da fila de solicitação. O estado deve estar ativo ou inativo.

[in] PropertyInformation

Um ponteiro para o buffer que contém as informações da propriedade.

pPropertyInformation aponta para um dos seguintes tipos de informações de propriedade com base na propriedade definida.

Propriedade	Tipo de Configuração
HttpServerStateProperty	enumeração HTTP_ENABLED_STATE
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	enumeração HTTP_503_RESPONSE_VERBOSITY

[in] PropertyInformationLength

O comprimento, em bytes, do buffer apontado pelo parâmetro pPropertyInformation .

[in] Reserved1

Reservado. Deve ser zero.

[in] Reserved2

Reservado. Deve ser NULL.

Retornar valor

Se a função for bem-sucedida, ela retornará NO_ERROR.

Se a função falhar, ela retornará um dos seguintes códigos de erro.

Valor	Significado
ERROR_INVALID_PARAMETER	O parâmetro Reserved não é zero ou o parâmetro pReserved não é NULL. Não há suporte para o tipo de propriedade especificado no parâmetro Property para filas de solicitação. O parâmetro pPropertyInformation é NULL. O parâmetro PropertyInformationLength é zero. O aplicativo não tem permissão para definir propriedades na fila de solicitações. Somente o aplicativo que criou a fila de solicitações pode definir as propriedades.
ERROR_NOT_SUPPORTED	O identificador para a fila de solicitações é um identificador HTTP versão 1.0. O gerenciamento de propriedades só tem suporte em filas de solicitação HTTP versão 2.0 ou posterior.

Valor

Significado

ERROR_INVALID_PARAMETER

O parâmetro Reserved não é zero ou o parâmetro pReserved não é NULL.

Não há suporte para o tipo de propriedade especificado no parâmetro Property para filas de solicitação.

O parâmetro pPropertyInformation é NULL.

O parâmetro PropertyInformationLength é zero.

O aplicativo não tem permissão para definir propriedades na fila de solicitações. Somente o aplicativo que criou a fila de solicitações pode definir as propriedades.

ERROR_NOT_SUPPORTED

O identificador para a fila de solicitações é um identificador HTTP versão 1.0. O gerenciamento de propriedades só tem suporte em filas de solicitação HTTP versão 2.0 ou posterior.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	http.h
Biblioteca	Httpapi.lib
DLL	Httpapi.dll

Confira também

Funções da API do Servidor HTTP versão 2.0

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpQueryRequestQueueProperty

HttpShutdownRequestQueue

Compartilhar via