HttpQueryServerSessionProperty, fonction (http.h)
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 de l’énumération HTTP_SERVER_PROPERTY qui décrit le type de propriété interrogé. Il peut s’agir de l’un des éléments suivants.
[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 par 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 |
---|---|
|
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 ServerSessionId ne contient pas de session de serveur valide. Le paramètre pPropertyInformation est NULL. Le paramètre PropertyInformationLength est zéro. L’application n’a pas l’autorisation d’interroger les propriétés de session du serveur. Seule l’application qui a créé la session de serveur peut interroger les propriétés. |
|
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é. Lors de la sortie, appelez à nouveau la fonction avec une mémoire tampon au moins aussi grande que la taille pointé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, lorsque vous interrogez httpServerTimeoutsProperty , le paramètre pPropertyInformation doit pointer vers une mémoire tampon qui est au moins la taille de la structure HTTP_TIMEOUT_LIMIT_INFO .
Pour spécifier la propriété HttpServerQosProperty dans le paramètre pPropertyInformation , définissez QosType sur HttpQosSettingTypeBandwidth à l’intérieur de la structure HTTP_QOS_SETTING_INFO et transmettez un pointeur à cette structure dans le paramètre.
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