Fonction HttpQueryServerSessionProperty (http.h)

Article
08/24/2023

La fonction HttpQueryServerSessionProperty interroge une propriété de serveur sur la session de serveur spécifiée.

Syntaxe

HTTPAPI_LINKAGE ULONG HttpQueryServerSessionProperty(
  [in]            HTTP_SERVER_SESSION_ID ServerSessionId,
  [in]            HTTP_SERVER_PROPERTY   Property,
  [out]           PVOID                  PropertyInformation,
  [in]            ULONG                  PropertyInformationLength,
  [out, optional] PULONG                 ReturnLength
);

Paramètres

[in] ServerSessionId

Session de serveur pour laquelle le paramètre de propriété est retourné.

[in] Property

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

Propriété	Signification
HttpServerStateProperty	Interroge l’état actuel de la session serveur.
HttpServerTimeoutsProperty	Interroge les limites de délai d’expiration de connexion de session serveur.
HttpServerQosProperty	Interroge la limitation de bande passante pour la session serveur. Par défaut, l’API serveur HTTP ne limite pas la bande passante.
HttpServerAuthenticationProperty	Interroge l’authentification côté serveur en mode noyau pour les schémas d’authentification De base, NTLM, Negotiate et Digest.
HttpServerChannelBindProperty	Interroge les propriétés du jeton de liaison de canal (CBT).

[out] PropertyInformation

Pointeur vers la mémoire tampon qui reçoit les données de propriété.

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

Propriété	Structure
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerChannelBindProperty	HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

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

[out, optional] ReturnLength

Nombre, en octets, retourné dans la mémoire tampon pPropertyInformation .

Si la mémoire tampon de sortie est trop petite, l’appel échoue avec une valeur de retour de ERROR_MORE_DATA. La valeur pointée par pReturnLength peut être utilisée pour déterminer la longueur minimale de la mémoire tampon requise pour que l’appel réussisse.

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 serveur. Le paramètre ServerSessionId ne contient pas de session de serveur valide. Le paramètre pPropertyInformation est NULL. Le paramètre PropertyInformationLength est égal à zéro. L’application n’est pas autorisée à interroger les propriétés de session de serveur. Seule l’application qui a créé la session serveur peut interroger les propriétés.
ERROR_MORE_DATA	La taille, en octets, de la mémoire tampon pointée par le paramètre pPropertyInformation est trop petite pour recevoir les données de propriété. À la sortie, appelez à nouveau la fonction avec une mémoire tampon au moins aussi grande que la taille indiquée par pReturnLength à la sortie.

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 serveur.

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

Le paramètre pPropertyInformation est NULL.

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

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

ERROR_MORE_DATA

La taille, en octets, de la mémoire tampon pointée par le paramètre pPropertyInformation est trop petite pour recevoir les données de propriété. À la sortie, appelez à nouveau la fonction avec une mémoire tampon au moins aussi grande que la taille indiquée par pReturnLength à la sortie.

Remarques

L’interrogation de HttpServerLoggingProperty n’est pas prise en charge.

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

Pour spécifier la propriété HttpServerQosProperty dans le paramètre pPropertyInformation , affectez à QosType la valeur HttpQosSettingTypeBandwidth à l’intérieur de la structure HTTP_QOS_SETTING_INFO et transmettez un pointeur vers cette structure dans le paramètre .

Configuration requise

Condition requise	Valeur
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