función if_indextoname (netioapi.h)

Artículo
03/13/2024

La función if_indextoname convierte el índice local de una interfaz de red en el nombre de la interfaz ANSI.

Sintaxis

IPHLPAPI_DLL_LINKAGE PCHAR NETIOAPI_API_ if_indextoname(
  [in]  NET_IFINDEX InterfaceIndex,
  [out] PCHAR       InterfaceName
);

Parámetros

[in] InterfaceIndex

Índice local de una interfaz de red.

[out] InterfaceName

Puntero a un búfer que contiene la cadena ANSI terminada en NULL que contiene el nombre de la interfaz cuando la función devuelve correctamente. La longitud, en bytes, del búfer al que apunta este parámetro debe ser igual o mayor que IF_NAMESIZE.

Valor devuelto

Si se ejecuta correctamente, if_indextoname devuelve un puntero a una cadena ANSI terminada en NULL que contiene el nombre de la interfaz. En caso de error, se devuelve un puntero NULL .

Comentarios

La función if_indextoname está disponible en Windows Vista y versiones posteriores.

La función if_indextoname asigna un índice de interfaz a su nombre correspondiente. Esta función está diseñada como parte de las extensiones de socket básicas para IPv6, tal como se describe en IETF en RFC 2553. Para obtener más información, vea http://www.ietf.org/rfc/rfc2553.txt.

La función if_indextoname se implementa para la portabilidad de aplicaciones con entornos Unix, pero se prefieren las funciones ConvertInterface. La función if_indextoname se puede reemplazar por una llamada a la función ConvertInterfaceIndexToLuid para convertir un índice de interfaz en un NET_LUID seguido de una llamada a ConvertInterfaceLuidToNameA para convertir la NET_LUID en el nombre de la interfaz ANSI.

Si se produce un error en el if_indextoname y devuelve un puntero NULL , no es posible determinar un código de error.

La longitud, en bytes, del búfer al que apunta el parámetro InterfaceName debe ser igual o mayor que IF_NAMESIZE, un valor declarado en el archivo de encabezado Netioapi.h igual a NDIS_IF_MAX_STRING_SIZE. La longitud máxima de un nombre de interfaz, NDIS_IF_MAX_STRING_SIZE, sin el valor NULL de terminación se declara en el archivo de encabezado Ntddndis.h . El NDIS_IF_MAX_STRING_SIZE se define como la constante IF_MAX_STRING_SIZE definida en el archivo de encabezado Ifdef.h . Los archivos de encabezado Ntddndis.h y Ifdef.h se incluyen automáticamente en el archivo de encabezado Netioapi.h , que el archivo de encabezado Iphlpapi.h incluye automáticamente. Los archivos de encabezado Ntddndis.h, Ifdef.h y Netioapi.h nunca se deben usar directamente.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	netioapi.h (incluya Iphlpapi.h)
Library	Iphlpapi.lib
Archivo DLL	Iphlpapi.dll