HttpSetServerSessionProperty, fonction (http.h)

La fonction HttpSetServerSessionProperty définit une nouvelle propriété de session de serveur ou modifie une propriété existante sur la session de serveur spécifiée.

Syntaxe

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

Paramètres

[in] ServerSessionId

Session de serveur pour laquelle la propriété est définie.

[in] Property

Membre de l’énumération HTTP_SERVER_PROPERTY qui décrit le type de propriété défini. Il peut s’agir de l’un des éléments suivants.

Propriété Signification
HttpServerStateProperty
Modifie ou définit l’état de la session de serveur. L’état peut être activé ou désactivé ; l’état par défaut est activé.
HttpServerTimeoutsProperty
Modifie ou définit les limites de délai d’expiration de connexion de session du serveur.
HttpServerQosProperty
Modifie ou définit la limitation de bande passante pour la session de serveur. Par défaut, l’API serveur HTTP ne limite pas la bande passante.
Note Cette valeur est mappée à la structure HTTP_QOS_SETTING_INFO générique avec QosType défini sur HttpQosSettingTypeBandwidth.
 
HttpServerLoggingProperty
Active ou désactive la journalisation pour la session de serveur. Cette propriété définit uniquement la journalisation binaire centralisée W3C et centralisée. Par défaut, la journalisation n’est pas activée.
HttpServerAuthenticationProperty
Active l’authentification côté serveur en mode noyau pour les schémas d’authentification De base, NTLM, Negotiate et Digest.
HttpServerExtendedAuthenticationProperty
Active l’authentification côté serveur en mode noyau pour le schéma d’authentification Kerberos.
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 données de propriété.

pPropertyInformation pointe vers une structure de données de propriété, répertoriée dans le tableau suivant, en fonction de la propriété définie.

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

Longueur, en octets, de la mémoire tampon pointée par 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 sessions de serveur.

Le paramètre pPropertyInformation est NULL.

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

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

L’application n’est pas autorisée à définir les propriétés de session du serveur. Seule l’application qui a créé la session de serveur peut définir les propriétés.

Notes

Les sessions serveur sont des conteneurs de configuration de niveau supérieur pour les données de configuration qui s’appliquent à tous les groupes d’URL créés sous ces derniers. La session de serveur est créée avec HttpCreateServerSession.

Le paramètre pPropertyInformation pointe vers la structure de configuration du type de propriété défini. Le paramètre PropertyInformationLength spécifie la taille, en octets, de la structure de configuration. Par exemple, lors de la définition du paramètre HttpServerTimeoutsProperty , le paramètre pPropertyInformation doit pointer vers une mémoire tampon qui est au moins égale à la taille de la structure HTTP_TIMEOUT_LIMIT_INFO .

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

Voir aussi

Fonctions de l’API serveur HTTP version 2.0

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty