Fonction LookupPersistentUdpPortReservation (iphlpapi.h)

Article
08/24/2023

La fonction LookupPersistentUdpPortReservation recherche le jeton pour une réservation de port UDP persistante pour un bloc consécutif de ports TCP sur l’ordinateur local.

Syntaxe

IPHLPAPI_DLL_LINKAGE ULONG LookupPersistentUdpPortReservation(
  [in]  USHORT   StartPort,
  [in]  USHORT   NumberOfPorts,
  [out] PULONG64 Token
);

Paramètres

[in] StartPort

Numéro de port UDP de départ dans l’ordre d’octet réseau.

[in] NumberOfPorts

Nombre de numéros de port UDP réservés.

[out] Token

Pointeur vers un jeton de réservation de port retourné si la fonction réussit.

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.

Code de retour	Description
ERROR_INVALID_PARAMETER	Un paramètre non valide a été transmis à la fonction. Cette erreur est retournée si zéro est passé dans les paramètres StartPort ou NumberOfPorts .
ERROR_NOT_FOUND	L'élément est introuvable. Cette erreur est retournée si le bloc de port persistant spécifié par les paramètres StartPort et NumberOfPorts est introuvable.
Autres	Utilisez FormatMessage pour obtenir la chaîne de message pour l’erreur retournée.

Remarques

La fonction LookupPersistentUdpPortReservation est définie sur Windows Vista et versions ultérieures.

La fonction LookupPersistentUdpPortReservation est utilisée pour rechercher le jeton d’une réservation persistante pour un bloc de ports UDP.

Une réservation persistante pour un bloc de ports UDP est créée par un appel à la fonction CreatePersistentUdpPortReservation . Les paramètres StartPort ou NumberOfPorts passés à la fonction LookupPersistentUdpPortReservation doivent correspondre aux valeurs utilisées lors de la création de la réservation permanente pour un bloc de ports TCP par la fonction CreatePersistentUdpPortReservation .

Si la fonction LookupPersistentUdpPortReservation réussit, le paramètre Token retourné pointe vers le jeton pour la réservation de port persistant pour le bloc de ports UDP. Notez que le jeton d’une réservation permanente donnée pour un bloc de ports TCP peut changer chaque fois que le système est redémarré.

Une application peut demander des affectations de ports à partir de la réservation de port UDP en ouvrant un socket UDP, puis en appelant la fonction WSAIoctl en spécifiant le SIO_ASSOCIATE_PORT_RESERVATION IOCTL et en transmettant le jeton de réservation avant d’émettre un appel à la fonction de liaison sur le socket.

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	iphlpapi.h
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll