GetBestInterfaceEx, fonction (iphlpapi.h)

Article
08/24/2023

La fonction GetBestInterfaceEx récupère l’index de l’interface qui a la meilleure route vers l’adresse IPv4 ou IPv6 spécifiée.

Syntaxe

IPHLPAPI_DLL_LINKAGE DWORD GetBestInterfaceEx(
  [in]  sockaddr *pDestAddr,
  [out] PDWORD   pdwBestIfIndex
);

Paramètres

[in] pDestAddr

Adresse IPv6 ou IPv4 de destination pour laquelle récupérer l’interface avec le meilleur itinéraire, sous la forme d’une structure sockaddr .

[out] pdwBestIfIndex

Pointeur vers l’index de l’interface avec la meilleure route vers l’adresse IPv6 ou IPv4 spécifiée par pDestAddr.

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_CAN_NOT_COMPLETE	L'opération n'a pas pu être terminée.
ERROR_INVALID_PARAMETER	Un paramètre non valide a été transmis à la fonction. Cette erreur est retournée si un pointeur NULL est passé dans le paramètre pdwBestIfIndex ou si les paramètres pDestAddr ou pdwBestIfIndex pointent vers la mémoire inaccessible. Cette erreur peut également être retournée si le paramètre pdwBestIfIndex pointe vers la mémoire dans laquelle il n’est pas possible d’écrire.
ERROR_NOT_SUPPORTED	La demande n'est pas prise en charge. Cette erreur est retournée si aucune pile IPv4 ne se trouve sur l’ordinateur local et si une adresse IPv4 a été spécifiée dans le paramètre pDestAddr ou si aucune pile IPv6 ne se trouve sur l’ordinateur local et qu’une adresse IPv6 a été spécifiée dans le paramètre pDestAddr .
Autres	Utilisez la fonction FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Notes

La fonction GetBestInterfaceEx diffère de la fonction GetBestInterface en ce qu’elle peut être utilisée avec des adresses IPv4 ou IPv6.

Le membre Family de la structure sockaddr pointée par le paramètre pDestAddr doit être défini sur l’une des valeurs suivantes : AF_INET ou AF_INET6.

Sur Windows Vista et versions ultérieures, le paramètre pdwBestIfIndex est traité en interne par IP Helper comme pointeur vers un type de données NET_IFINDEX .

Spécifications


Client minimal pris en charge	Windows XP [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	iphlpapi.h
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll