Fonction HttpSetRequestQueueProperty (http.h)

Article
08/24/2023

La fonction HttpSetRequestQueueProperty définit une nouvelle propriété ou modifie une propriété existante dans la file d’attente de requêtes identifiée par le handle spécifié.

Syntaxe

HTTPAPI_LINKAGE ULONG HttpSetRequestQueueProperty(
  [in] HANDLE               RequestQueueHandle,
  [in] HTTP_SERVER_PROPERTY Property,
  [in] PVOID                PropertyInformation,
  [in] ULONG                PropertyInformationLength,
  [in] ULONG                Reserved1,
  [in] PVOID                Reserved2
);

Paramètres

[in] RequestQueueHandle

Handle de la file d’attente de requêtes sur laquelle la propriété est définie. Une file d’attente de requêtes est créée et son handle est retourné par un appel à la fonction HttpCreateRequestQueue .

[in] Property

Membre du HTTP_SERVER_PROPERTY énumération décrivant le type de propriété défini. Il doit s’agir de l’un des éléments suivants :

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

[in] PropertyInformation

Pointeur vers la mémoire tampon qui contient les informations de propriété.

pPropertyInformation pointe vers l’un des types d’informations de propriété suivants en fonction de la propriété définie.

Propriété	Type de configuration
HttpServerStateProperty	énumération HTTP_ENABLED_STATE
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	énumération HTTP_503_RESPONSE_VERBOSITY

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

[in] Reserved2

Réservé. 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 pour les files d’attente de requêtes. Le paramètre pPropertyInformation est NULL. Le paramètre PropertyInformationLength est égal à zéro. L’application n’est pas autorisée à définir des propriétés dans la file d’attente des demandes. Seule l’application qui a créé la file d’attente des requêtes peut définir les propriétés.
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 sur les files d’attente de requêtes HTTP version 2.0 ou ultérieure.

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 pour les files d’attente de requêtes.

Le paramètre pPropertyInformation est NULL.

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

L’application n’est pas autorisée à définir des propriétés dans la file d’attente des demandes. Seule l’application qui a créé la file d’attente des requêtes peut définir les propriétés.

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 sur les files d’attente de requêtes HTTP version 2.0 ou ultérieure.

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

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpQueryRequestQueueProperty

HttpShutdownRequestQueue

Partager via