Função HttpSetUrlGroupProperty (http.h)

Artigo
08/24/2023

A função HttpSetUrlGroupProperty define uma nova propriedade ou modifica uma propriedade existente no grupo de URL especificado.

Sintaxe

HTTPAPI_LINKAGE ULONG HttpSetUrlGroupProperty(
  [in] HTTP_URL_GROUP_ID    UrlGroupId,
  [in] HTTP_SERVER_PROPERTY Property,
  [in] PVOID                PropertyInformation,
  [in] ULONG                PropertyInformationLength
);

Parâmetros

[in] UrlGroupId

A ID do Grupo de URL para o qual a propriedade está definida.

[in] Property

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

Propriedade	Significado
HttpServerAuthenticationProperty	Habilita a autenticação do lado do servidor para o Grupo de URLs usando os esquemas de autenticação Basic, NTLM, Negotiate e Digest.
HttpServerExtendedAuthenticationProperty	Habilita a autenticação do lado do servidor para o Grupo de URLs usando o esquema de autenticação Kerberos.
HttpServerQosProperty	Esse valor é mapeado para a estrutura de HTTP_QOS_SETTING_INFO genérica com QosType definido como HttpQosSettingTypeBandwidth ou HttpQosSettingTypeConnectionLimit. Se HttpQosSettingTypeBandwidth, modificar ou definir a limitação de largura de banda para o Grupo de URL. Se HttpQosSettingTypeConnectionLimit, modificar ou definir o número máximo de conexões pendentes atendidas para um grupo de URL a qualquer momento.
HttpServerBindingProperty	Modifica ou define a associação do Grupo de URL com uma fila de solicitação.
HttpServerLoggingProperty	Modifica ou define o registro em log para o Grupo de URLs.
HttpServerStateProperty	Modifica ou define o estado do Grupo de URLs. O estado pode ser habilitado ou desabilitado.
HttpServerTimeoutsProperty	Modifica ou define os limites de tempo limite de conexão para o Grupo de URLs.
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 as informações da propriedade.

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

Propriedade	Estrutura
HttpServerAuthenticatonProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerExtendedAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerBindingProperty	HTTP_BINDING_INFO
HttpServerLoggingProperty	HTTP_LOGGING_INFO
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerChannelBindProperty	HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

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

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 pPropertyInformation é NULL. O parâmetro PropertyInformationLength é zero. O parâmetro UrlGroupId não contém uma sessão de servidor válida. O aplicativo não tem permissão para definir as propriedades do Grupo de URL. Somente o aplicativo que criou o Grupo de URL pode definir as propriedades.

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

O parâmetro PropertyInformationLength é zero.

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

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

Comentários

Depois que o Grupo de URL é criado, ele deve ser associado a uma fila de solicitações para receber solicitações. Para associar o Grupo de URLs a uma fila de solicitação, o aplicativo chama HttpSetUrlGroupProperty com a propriedade HttpServerBindingProperty . Se essa propriedade não estiver definida, as solicitações correspondentes para o Grupo de URL não serão entregues a uma fila de solicitações e a API do servidor HTTP gerará uma resposta 503.

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