Função HttpQueryUrlGroupProperty (http.h)

Artigo
08/24/2023

A função HttpQueryUrlGroupProperty consulta uma propriedade no Grupo de URL especificado.

Sintaxe

HTTPAPI_LINKAGE ULONG HttpQueryUrlGroupProperty(
  [in]            HTTP_URL_GROUP_ID    UrlGroupId,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [out, optional] PULONG               ReturnLength
);

Parâmetros

[in] UrlGroupId

A ID do Grupo de URL para o qual a configuração da propriedade é retornada.

[in] Property

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

Propriedade	Significado
HttpServerAuthenticationProperty	Consulta os esquemas de autenticação do lado do servidor habilitados.
HttpServerTimeoutsProperty	Consulta os limites de tempo limite de conexão do Grupo de URL.
HttpServerStateProperty	Consulta o estado atual do Grupo de URLs. O estado pode ser habilitado ou desabilitado.
HttpServerQosProperty	Esse valor é mapeado para a estrutura de HTTP_QOS_SETTING_INFO genérica com QosType definido como HttpQosSettingTypeBandwidth ou HttpQosSettingTypeConnectionLimit. Se HttpQosSettingTypeBandwidth, consulta a limitação de largura de banda para o Grupo de URL. Se HttpQosSettingTypeConnectionLimit, consultará o número máximo de conexões pendentes atendidas para um grupo de URL a qualquer momento.
HttpServerChannelBindProperty	Consulta as propriedades do CBT (token de associação de canal).

[out] PropertyInformation

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

pPropertyInformation aponta para uma das seguintes estruturas de informações de propriedade com base na propriedade que é consultada.

Propriedade	Estrutura
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerChannelBindProperty	HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

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

[out, optional] ReturnLength

O tamanho, em bytes, retornado no buffer pPropertyInformation .

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.

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 tipo de propriedade especificado no parâmetro Property não tem suporte para grupos de URL. O parâmetro UrlGroupId não identifica um grupo de URL de servidor válido. O parâmetro pPropertyInformation é NULL. O parâmetro PropertyInformationLength é zero. O aplicativo não tem permissão para consultar as propriedades do Grupo de URLs. Somente o aplicativo que criou o Grupo de URL pode consultar as propriedades.
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.

Valor

Significado

ERROR_INVALID_PARAMETER

O tipo de propriedade especificado no parâmetro Property não tem suporte para grupos de URL.

O parâmetro UrlGroupId não identifica um grupo de URL de servidor válido.

O parâmetro pPropertyInformation é NULL.

O parâmetro PropertyInformationLength é zero.

O aplicativo não tem permissão para consultar as propriedades do Grupo de URLs. Somente o aplicativo que criou o Grupo de URL pode consultar as propriedades.

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.

Comentários

Não há suporte para consultar o HttpServerLoggingProperty .

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