HttpSetUrlGroupProperty, fonction (http.h)

Article
08/24/2023

La fonction HttpSetUrlGroupProperty définit une nouvelle propriété ou modifie une propriété existante sur le groupe d’URL spécifié.

Syntaxe

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

Paramètres

[in] UrlGroupId

ID du groupe d’URL pour lequel la propriété est définie.

[in] Property

Membre de l’énumération HTTP_SERVER_PROPERTY qui décrit le type de propriété modifié ou défini. Il peut s'agir de l'une des ressources suivantes :

Propriété	Signification
HttpServerAuthenticationProperty	Active l’authentification côté serveur pour le groupe d’URL à l’aide des schémas d’authentification De base, NTLM, Negotiate et Digest.
HttpServerExtendedAuthenticationProperty	Active l’authentification côté serveur pour le groupe d’URL à l’aide du schéma d’authentification Kerberos.
HttpServerQosProperty	Cette valeur correspond à la structure de HTTP_QOS_SETTING_INFO générique avec QosType défini sur HttpQosSettingTypeBandwidth ou HttpQosSettingTypeConnectionLimit. Si HttpQosSettingTypeBandwidth, modifie ou définit la limitation de bande passante pour le groupe d’URL. Si HttpQosSettingTypeConnectionLimit, modifie ou définit à tout moment le nombre maximal de connexions en attente pour un groupe d’URL.
HttpServerBindingProperty	Modifie ou définit l’association de groupe d’URL avec une file d’attente de requêtes.
HttpServerLoggingProperty	Modifie ou définit la journalisation pour le groupe d’URL.
HttpServerStateProperty	Modifie ou définit l’état du groupe d’URL. L’état peut être activé ou désactivé.
HttpServerTimeoutsProperty	Modifie ou définit les limites de délai d’expiration de connexion pour le groupe d’URL.
HttpServerChannelBindProperty	Active l’authentification côté serveur qui utilise un jeton de liaison de canal (CBT).

[in] PropertyInformation

Pointeur vers la mémoire tampon qui contient les informations de propriété.

pPropertyInformation pointe vers l’une des structures d’informations de propriété suivantes en fonction de la propriété définie.

Propriété	Structure
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

Longueur, en octets, de la mémoire tampon pointée vers le paramètre pPropertyInformation .

Valeur retournée

Si la fonction réussit, elle retourne NO_ERROR.

Si la fonction échoue, elle retourne l’un des codes d’erreur suivants.

Valeur	Signification
ERROR_INVALID_PARAMETER	Le type de propriété spécifié dans le paramètre Property n’est pas pris en charge pour les groupes d’URL. Le paramètre pPropertyInformation est NULL. Le paramètre PropertyInformationLength est égal à zéro. Le paramètre UrlGroupId ne contient pas de session de serveur valide. L’application n’est pas autorisée à définir les propriétés du groupe d’URL. Seule l’application qui a créé le groupe d’URL peut définir les propriétés.

Valeur

Signification

ERROR_INVALID_PARAMETER

Le type de propriété spécifié dans le paramètre Property n’est pas pris en charge pour les groupes d’URL.

Le paramètre pPropertyInformation est NULL.

Le paramètre PropertyInformationLength est égal à zéro.

Le paramètre UrlGroupId ne contient pas de session de serveur valide.

L’application n’est pas autorisée à définir les propriétés du groupe d’URL. Seule l’application qui a créé le groupe d’URL peut définir les propriétés.

Notes

Une fois le groupe d’URL créé, il doit être associé à une file d’attente de demandes pour recevoir des demandes. Pour associer le groupe d’URL à une file d’attente de requêtes, l’application appelle HttpSetUrlGroupProperty avec la propriété HttpServerBindingProperty . Si cette propriété n’est pas définie, les demandes correspondantes pour le groupe d’URL ne sont pas remises à une file d’attente de requêtes et l’API serveur HTTP génère une réponse 503.

Configuration requise


Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	http.h
Bibliothèque	Httpapi.lib
DLL	Httpapi.dll