Función HttpSetUrlGroupProperty (http.h)

Artículo
08/24/2023

La función HttpSetUrlGroupProperty establece una nueva propiedad o modifica una propiedad existente en el grupo de direcciones URL especificado.

Sintaxis

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

Identificador del grupo de direcciones URL para el que se establece la propiedad.

[in] Property

Miembro de la enumeración HTTP_SERVER_PROPERTY que describe el tipo de propiedad que se modifica o establece. Este puede ser uno de los siguientes:

Propiedad	Significado
HttpServerAuthenticationProperty	Habilita la autenticación del lado servidor para el grupo de direcciones URL mediante los esquemas de autenticación Básico, NTLM, Negotiate y Digest.
HttpServerExtendedAuthenticationProperty	Habilita la autenticación del lado servidor para el grupo de direcciones URL mediante el esquema de autenticación Kerberos.
HttpServerQosProperty	Este valor se asigna a la estructura genérica de HTTP_QOS_SETTING_INFO con QosType establecido en HttpQosSettingTypeBandwidth o HttpQosSettingTypeConnectionLimit. Si HttpQosSettingTypeBandwidth, modifica o establece la limitación de ancho de banda para el grupo de direcciones URL. Si HttpQosSettingTypeConnectionLimit, modifica o establece el número máximo de conexiones pendientes que se sirven para un grupo de direcciones URL en cualquier momento.
HttpServerBindingProperty	Modifica o establece la asociación de grupo de direcciones URL con una cola de solicitudes.
HttpServerLoggingProperty	Modifica o establece el registro para el grupo de direcciones URL.
HttpServerStateProperty	Modifica o establece el estado del grupo de direcciones URL. El estado se puede habilitar o deshabilitar.
HttpServerTimeoutsProperty	Modifica o establece los límites de tiempo de espera de conexión para el grupo de direcciones URL.
HttpServerChannelBindProperty	Habilita la autenticación del lado servidor que usa un token de enlace de canal (CBT).

[in] PropertyInformation

Puntero al búfer que contiene la información de la propiedad.

pPropertyInformation apunta a una de las siguientes estructuras de información de propiedad basadas en la propiedad establecida.

Propiedad	Estructura
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

Longitud, en bytes, del búfer al que apunta el parámetro pPropertyInformation .

Valor devuelto

Si la función se realiza correctamente, devuelve NO_ERROR.

Si se produce un error en la función, devuelve uno de los siguientes códigos de error.

Valor	Significado
ERROR_INVALID_PARAMETER	El tipo de propiedad especificado en el parámetro Property no se admite para los grupos de direcciones URL. El parámetro pPropertyInformation es NULL. El parámetro PropertyInformationLength es cero. El parámetro UrlGroupId no contiene una sesión de servidor válida. La aplicación no tiene permiso para establecer las propiedades del grupo de direcciones URL. Solo la aplicación que creó el grupo de direcciones URL puede establecer las propiedades.

Valor

Significado

ERROR_INVALID_PARAMETER

El tipo de propiedad especificado en el parámetro Property no se admite para los grupos de direcciones URL.

El parámetro pPropertyInformation es NULL.

El parámetro PropertyInformationLength es cero.

El parámetro UrlGroupId no contiene una sesión de servidor válida.

La aplicación no tiene permiso para establecer las propiedades del grupo de direcciones URL. Solo la aplicación que creó el grupo de direcciones URL puede establecer las propiedades.

Comentarios

Una vez creado el grupo de direcciones URL, debe estar asociado a una cola de solicitudes para recibir solicitudes. Para asociar el grupo de direcciones URL a una cola de solicitudes, la aplicación llama a HttpSetUrlGroupProperty con la propiedad HttpServerBindingProperty . Si no se establece esta propiedad, las solicitudes coincidentes para el grupo de direcciones URL no se entregan a una cola de solicitudes y la API del servidor HTTP genera una respuesta 503.

Requisitos


Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	http.h
Library	Httpapi.lib
Archivo DLL	Httpapi.dll