Fonction HttpQueryRequestQueueProperty (http.h)

Article
08/24/2023

La fonction HttpQueryRequestQueueProperty interroge une propriété de la file d’attente de requêtes identifiée par le handle spécifié.

Syntaxe

HTTPAPI_LINKAGE ULONG HttpQueryRequestQueueProperty(
                  HANDLE               RequestQueueHandle,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [in]            ULONG                Reserved1,
  [out, optional] PULONG               ReturnLength,
  [in]            PVOID                Reserved2
);

Paramètres

RequestQueueHandle

[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'une des ressources suivantes :

Propriété	Signification
HttpServer503VerbosityProperty	Interroge le niveau de détail actuel de 503 réponses générées pour la file d’attente des demandes.
HttpServerQueueLengthProperty	Interroge la limite du nombre de demandes en attente dans la file d’attente des requêtes.
HttpServerStateProperty	Interroge l’état actuel de la file d’attente des requêtes. L’état doit être actif ou inactif.

[out] PropertyInformation

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

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

Propriété	Valeur
HttpServerStateProperty	HTTP_ENABLED_STATE (membre d’énumération)
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	HTTP_503_RESPONSE_VERBOSITY (membre d’énumération)

[in] PropertyInformationLength

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

[in] Reserved1

Réservé. Doit être zéro.

[out, optional] ReturnLength

Nombre, en octets, retourné dans la mémoire tampon pPropertyInformation s’il n’est pas NULL.

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.

[in] Reserved2

Ce paramètre est réservé et doit être NULL.

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 paramètre Reserved n’est pas égal à zéro ou le paramètre pReserved n’est pas NULL. Le type de propriété spécifié dans le paramètre Property n’est pas pris en charge sur les files d’attente de demandes. Le paramètre pPropertyInformation est NULL. Le paramètre PropertyInformationLength est égal à zéro. L’application n’est pas autorisée à ouvrir la file d’attente des demandes.
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.
ERROR_NOT_SUPPORTED	Le handle de la file d’attente de requêtes est un handle HTTP version 1.0. La gestion des propriétés est uniquement prise en charge pour les files d’attente de requêtes HTTP version 2.0 et ultérieures.

Valeur

Signification

ERROR_INVALID_PARAMETER

Le paramètre Reserved n’est pas égal à zéro ou le paramètre pReserved n’est pas NULL.

Le type de propriété spécifié dans le paramètre Property n’est pas pris en charge sur les files d’attente de demandes.

Le paramètre pPropertyInformation est NULL.

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

L’application n’est pas autorisée à ouvrir la file d’attente des demandes.

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.

ERROR_NOT_SUPPORTED

Le handle de la file d’attente de requêtes est un handle HTTP version 1.0. La gestion des propriétés est uniquement prise en charge pour les files d’attente de requêtes HTTP version 2.0 et ultérieures.

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

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpSetRequestQueueProperty

HttpShutdownRequestQueue

Partager via