Fonction HttpAddUrl (http.h)

La fonction HttpAddUrl inscrit une URL donnée afin que les demandes qui lui correspondent soient routées vers une file d’attente de requêtes d’API de serveur HTTP spécifiée. Une application peut inscrire plusieurs URL dans une file d’attente de requêtes unique à l’aide d’appels répétés à HttpAddUrl. Pour plus d’informations sur la façon dont l’API serveur HTTP fait correspondre les URL de requête aux URL inscrites, consultez Chaînes UrlPrefix.

À compter de l’API serveur HTTP version 2.0, les applications doivent appeler HttpAddUrlToUrlGroup pour inscrire une URL ; HttpAddUrl ne doit pas être utilisé.

Syntaxe

HTTPAPI_LINKAGE ULONG HttpAddUrl(
  [in] HANDLE RequestQueueHandle,
  [in] PCWSTR FullyQualifiedUrl,
       PVOID  Reserved
);

Paramètres

[in] RequestQueueHandle

Handle de la file d’attente de requêtes vers laquelle les demandes pour l’URL spécifiée doivent être routées. Une file d’attente de requêtes est créée et son handle est retourné par un appel à la fonction HttpCreateRequestQueue .

Windows Server 2003 avec SP1 et Windows XP avec SP2 : Le handle de la file d’attente des requêtes est créé par la fonction HttpCreateHttpHandle .

[in] FullyQualifiedUrl

Pointeur vers une chaîne Unicode qui contient une chaîne UrlPrefix correctement formée qui identifie l’URL à inscrire.

Reserved

Réservés au; doit être NULL.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Valeur	Signification
ERROR_ACCESS_DENIED	L’application appelante n’est pas autorisée à inscrire l’URL.
ERROR_DLL_INIT_FAILED	L’application appelante n’a pas appelé HttpInitialize avant d’appeler cette fonction.
ERROR_INVALID_PARAMETER	L’un des paramètres n’est pas valide.
ERROR_ALREADY_EXISTS	Le paramètre UrlPrefix spécifié est en conflit avec une inscription existante.
ERROR_NOT_ENOUGH_MEMORY	Ressources insuffisantes pour terminer l’opération.
Autres	Code d’erreur système défini dans WinError.h.

Remarques

Comme indiqué dans la rubrique Chaînes UrlPrefix , la spécification de schéma de l’UrlPrefix à inscrire doit être « http » en minuscules ou « https » en minuscules. Aucune autre sous-chaîne n’est valide.

En outre, il n’est pas possible d’inscrire des URL ayant des schémas différents sur le même port. Autrement dit, les schémas « http » et « https » ne peuvent pas coexister sur un port.

Sachez également que HttpAddUrl enregistre tout UrlPrefix qui lui est passé tant que la chaîne est bien formée. Toute validation de l’existence, de l’accessibilité, de la propriété ou d’autres caractéristiques de l’espace de noms URL spécifié doit être gérée par l’application.

Pour libérer les ressources allouées à la suite de l’inscription effectuée par HttpAddUrl, effectuez un appel correspondant à la fonction HttpRemoveUrl lorsque votre application a terminé l’espace de noms impliqué.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista, Windows XP avec SP2 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [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 1.0

HttpAddUrlToUrlGroup

HttpRemoveUrl