GetBestInterface, fonction (iphlpapi.h)

Article
02/28/2024

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

Syntaxe

IPHLPAPI_DLL_LINKAGE DWORD GetBestInterface(
  [in]  IPAddr dwDestAddr,
  [out] PDWORD pdwBestIfIndex
);

Paramètres

[in] dwDestAddr

Adresse IPv4 de destination pour laquelle récupérer l’interface qui a le meilleur itinéraire, sous la forme d’une structure IPAddr .

[out] pdwBestIfIndex

Pointeur vers une variable DWORD qui reçoit l’index de l’interface qui a la meilleure route vers l’adresse IPv4 spécifiée par dwDestAddr.

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 le pdwBestIfIndex pointe vers la mémoire qui ne peut pas être écrite.
ERROR_NOT_SUPPORTED	La demande n'est pas prise en charge. Cette erreur est retournée si aucune pile IPv4 n’est sur l’ordinateur local.
Autres	Utilisez la fonction FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Remarques

La fonction GetBestInterface fonctionne uniquement avec les adresses IPv4. Pour une utilisation avec des adresses IPv6, getBestInterfaceEx doit être utilisé.

Pour plus d’informations sur le type de données IPAddr , consultez Types de données Windows. Pour convertir une adresse IP entre la notation décimale en pointillés et le format IPAddr , utilisez les fonctions inet_addr et inet_ntoa .

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 .

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	iphlpapi.h
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll