Partager via


Fonction HttpQueryUrlGroupProperty (http.h)

La fonction HttpQueryUrlGroupProperty interroge une propriété sur le groupe d’URL spécifié.

Syntaxe

HTTPAPI_LINKAGE ULONG HttpQueryUrlGroupProperty(
  [in]            HTTP_URL_GROUP_ID    UrlGroupId,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [out, optional] PULONG               ReturnLength
);

Paramètres

[in] UrlGroupId

ID du groupe d’URL pour lequel 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'une des ressources suivantes :

Propriété Signification
HttpServerAuthenticationProperty
Interroge les schémas d’authentification côté serveur activés.
HttpServerTimeoutsProperty
Interroge les limites de délai d’expiration de connexion du groupe d’URL.
HttpServerStateProperty
Interroge l’état actuel du groupe d’URL. L’état peut être activé ou désactivé.
HttpServerQosProperty
Cette valeur correspond à la structure de HTTP_QOS_SETTING_INFO générique avec QosType défini sur HttpQosSettingTypeBandwidth ou HttpQosSettingTypeConnectionLimit. Si HttpQosSettingTypeBandwidth, interroge la limitation de bande passante pour le groupe d’URL. Si HttpQosSettingTypeConnectionLimit, interroge à tout moment le nombre maximal de connexions en attente pour un groupe d’URL.
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 informations de propriété.

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

Propriété Structure
HttpServerStateProperty HTTP_STATE_INFO
HttpServerAuthenticationProperty HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty HTTP_QOS_SETTING_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 .

[out, optional] ReturnLength

Taille, en octets, retournée 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 groupes d’URL.

Le paramètre UrlGroupId n’identifie pas un groupe d’URL 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 du groupe d’URL. Seule l’application qui a créé le groupe d’URL 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 informations de propriété. Appelez à nouveau la fonction avec une mémoire tampon au moins aussi grande que la taille indiquée par pReturnLength à la sortie.

Notes

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

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

HttpAddUrlToUrlGroup

HttpCloseUrlGroup

HttpCreateUrlGroup

HttpRemoveUrlFromUrlGroup

HttpSetUrlGroupProperty