Função HttpQueryServerSessionProperty (http.h)

  • Artigo

A função HttpQueryServerSessionProperty consulta uma propriedade de servidor na sessão de servidor especificada.

Sintaxe

HTTPAPI_LINKAGE ULONG HttpQueryServerSessionProperty(
  [in]            HTTP_SERVER_SESSION_ID ServerSessionId,
  [in]            HTTP_SERVER_PROPERTY   Property,
  [out]           PVOID                  PropertyInformation,
  [in]            ULONG                  PropertyInformationLength,
  [out, optional] PULONG                 ReturnLength
);

Parâmetros

[in] ServerSessionId

A sessão do servidor para a 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. Isso pode ser um dos seguintes.

Propriedade Significado
HttpServerStateProperty
 Consulta o estado atual da sessão do servidor.
HttpServerTimeoutsProperty
 Consulta os limites de tempo limite de conexão da sessão do servidor.
HttpServerQosProperty
 Consulta a limitação de largura de banda para a sessão do servidor. Por padrão, a API do Servidor HTTP não limita a largura de banda.
HttpServerAuthenticationProperty
 Consulta a autenticação do lado do servidor no modo kernel para os esquemas de autenticação Basic, NTLM, Negotiate e Digest.
HttpServerChannelBindProperty
 Consulta as propriedades do CBT (token de associação de canal).

[out] PropertyInformation

Um ponteiro para o buffer que recebe os dados da propriedade.

pPropertyInformation aponta para uma das seguintes estruturas de dados de propriedade com base na propriedade definida.

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

[in] PropertyInformationLength

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

[out, optional] ReturnLength

O número, 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.

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 tipo de propriedade especificado no parâmetro Property não tem suporte para sessões de servidor.

O parâmetro ServerSessionId não contém uma sessão de servidor válida.

O parâmetro pPropertyInformation é NULL.

O parâmetro PropertyInformationLength é zero.

O aplicativo não tem permissão para consultar as propriedades da sessão do servidor. Somente o aplicativo que criou a sessão do servidor pode consultar as propriedades.
ERROR_MORE_DATA
 O tamanho, em bytes, do buffer apontado pelo parâmetro pPropertyInformation é muito pequeno para receber os dados da propriedade. Ao sair, 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 .

O parâmetro pPropertyInformation aponta para a estrutura de configuração do tipo de propriedade que é consultado. O parâmetro PropertyInformationLength especifica o tamanho, em bytes, da estrutura de configuração. Por exemplo, ao consultar HttpServerTimeoutsProperty , o parâmetro pPropertyInformation deve apontar para um buffer que tenha pelo menos o tamanho da estrutura HTTP_TIMEOUT_LIMIT_INFO .

Para especificar a propriedade HttpServerQosProperty no parâmetro pPropertyInformation , defina QosType como HttpQosSettingTypeBandwidth dentro da estrutura HTTP_QOS_SETTING_INFO e passe um ponteiro para essa estrutura no parâmetro .

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

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty