Função HttpSetServerSessionProperty (http.h)

  • Artigo

A função HttpSetServerSessionProperty define uma nova propriedade de sessão de servidor ou modifica uma propriedade existente na sessão de servidor especificada.

Sintaxe

HTTPAPI_LINKAGE ULONG HttpSetServerSessionProperty(
  [in] HTTP_SERVER_SESSION_ID ServerSessionId,
  [in] HTTP_SERVER_PROPERTY   Property,
  [in] PVOID                  PropertyInformation,
  [in] ULONG                  PropertyInformationLength
);

Parâmetros

[in] ServerSessionId

A sessão do servidor para a qual a propriedade está definida.

[in] Property

Um membro da enumeração HTTP_SERVER_PROPERTY que descreve o tipo de propriedade definido. Essa pode ser uma das opções a seguir.

Propriedade Significado
HttpServerStateProperty
 Modifica ou define o estado da sessão do servidor. O estado pode ser habilitado ou desabilitado; o estado padrão está habilitado.
HttpServerTimeoutsProperty
 Modifica ou define os limites de tempo limite de conexão da sessão do servidor.
HttpServerQosProperty
 Modifica ou define 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.
Nota Esse valor é mapeado para a estrutura de HTTP_QOS_SETTING_INFO genérica com QosType definido como HttpQosSettingTypeBandwidth.
 
HttpServerLoggingProperty
 Habilita ou desabilita o registro em log para a sessão do servidor. Essa propriedade define apenas o W3C centralizado e o log binário centralizado. Por padrão, o registro em log não está habilitado.
HttpServerAuthenticationProperty
 Habilita a autenticação do lado do servidor no modo kernel para os esquemas de autenticação Basic, NTLM, Negotiate e Digest.
HttpServerExtendedAuthenticationProperty
 Habilita a autenticação do lado do servidor no modo kernel para o esquema de autenticação Kerberos.
HttpServerChannelBindProperty
Habilita a autenticação do lado do servidor que usa um CBT (token de associação de canal).

[in] PropertyInformation

Um ponteiro para o buffer que contém os dados da propriedade.

pPropertyInformation aponta para uma estrutura de dados de propriedade, listada na tabela a seguir, com base na propriedade definida.

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

[in] PropertyInformationLength

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

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 pPropertyInformation é NULL.

O parâmetro PropertyInformationLength é zero.

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

O aplicativo não tem permissão para definir as propriedades da sessão do servidor. Somente o aplicativo que criou a sessão do servidor pode definir as propriedades.

Comentários

As sessões de servidor são contêineres de configuração de nível superior para dados de configuração que se aplicam a todos os grupos de URL criados sob eles. A sessão do servidor é criada com HttpCreateServerSession.

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

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