Función GetBestInterface (iphlpapi.h)

Artículo
02/28/2024

La función GetBestInterface recupera el índice de la interfaz que tiene la mejor ruta a la dirección IPv4 especificada.

Sintaxis

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

Parámetros

[in] dwDestAddr

Dirección IPv4 de destino para la que se va a recuperar la interfaz que tiene la mejor ruta, en forma de una estructura IPAddr .

[out] pdwBestIfIndex

Puntero a una variable DWORD que recibe el índice de la interfaz que tiene la mejor ruta a la dirección IPv4 especificada por dwDestAddr.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Código devuelto	Descripción
ERROR_CAN_NOT_COMPLETE	No se pudo completar la operación.
ERROR_INVALID_PARAMETER	Se pasó un parámetro no válido a la función. Este error se devuelve si se pasa un puntero NULL en el parámetro pdwBestIfIndex o si pdwBestIfIndex apunta a la memoria que no se puede escribir.
ERROR_NOT_SUPPORTED	No se admite la solicitud. Este error se devuelve si no hay ninguna pila IPv4 en el equipo local.
Otros	Use la función FormatMessage para obtener la cadena de mensaje del error devuelto.

Comentarios

La función GetBestInterface solo funciona con direcciones IPv4. Para su uso con direcciones IPv6, se debe usar GetBestInterfaceEx .

Para obtener información sobre el tipo de datos IPAddr , vea Tipos de datos de Windows. Para convertir una dirección IP entre la notación decimal con puntos y el formato IPAddr , use las funciones inet_addr y inet_ntoa .

En Windows Vista y versiones posteriores, el parámetro pdwBestIfIndex se trata internamente mediante el asistente de IP como puntero a un tipo de datos NET_IFINDEX .

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	iphlpapi.h
Library	Iphlpapi.lib
Archivo DLL	Iphlpapi.dll