Função HttpQueryRequestQueueProperty (http.h)

A função HttpQueryRequestQueueProperty consulta uma propriedade da fila de solicitação identificada pelo identificador especificado.

Sintaxe

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

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

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

[out] PropertyInformation

Um ponteiro para o buffer que recebe as informações da propriedade.

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

Propriedade	Valor
HttpServerStateProperty	HTTP_ENABLED_STATE (membro de enumeração)
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	HTTP_503_RESPONSE_VERBOSITY (membro de enumeração)

[in] PropertyInformationLength

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

[in] Reserved1

Reservado. Deve ser zero.

[out, optional] ReturnLength

O número, em bytes, retornado no buffer pPropertyInformation se não for NULL.

Se o buffer de saída for muito pequeno, a chamada falhará com um valor retornado de ERROR_MORE_DATA. O valor apontado por pReturnLength pode ser usado para determinar o comprimento mínimo do buffer necessário para que a chamada seja bem-sucedida.

[in] Reserved2

Esse parâmetro é reservado e deve ser NULL.

Valor retornado

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. O tipo de propriedade especificado no parâmetro Property não tem suporte em filas de solicitação. O parâmetro pPropertyInformation é NULL. O parâmetro PropertyInformationLength é zero. O aplicativo não tem permissão para abrir a fila de solicitação.
ERROR_MORE_DATA	O tamanho, em bytes, do buffer apontado pelo parâmetro pPropertyInformation é muito pequeno para receber as informações da propriedade. Chame a função novamente com um buffer pelo menos tão grande quanto o tamanho apontado por pReturnLength na saída.
ERROR_NOT_SUPPORTED	O identificador para a fila de solicitação é um identificador HTTP versão 1.0. O gerenciamento de propriedades só tem suporte para filas de solicitação HTTP versão 2.0 e posteriores.

Requisitos

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

HttpSetRequestQueueProperty

HttpShutdownRequestQueue