Función ConvertInterfaceLuidToAlias (netioapi.h)

Artículo
03/09/2024

La función ConvertInterfaceLuidToAlias convierte un identificador único local (LUID) para una interfaz de red en un alias de interfaz.

Sintaxis

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceLuidToAlias(
  [in]  const NET_LUID *InterfaceLuid,
  [out] PWSTR          InterfaceAlias,
  [in]  SIZE_T         Length
);

Parámetros

[in] InterfaceLuid

Puntero a un NET_LUID para una interfaz de red.

[out] InterfaceAlias

Puntero a un búfer que contiene la cadena Unicode terminada en NULL que contiene el nombre de alias de la interfaz de red cuando la función devuelve correctamente.

[in] Length

Longitud, en caracteres, del búfer al que apunta el parámetro InterfaceAlias . Este valor debe ser lo suficientemente grande como para dar cabida al nombre de alias de la interfaz de red y al carácter NULL de terminación. La longitud máxima necesaria es NDIS_IF_MAX_STRING_SIZE + 1.

Valor devuelto

Si se ejecuta correctamente, ConvertInterfaceLuidToAlias devuelve NO_ERROR. Cualquier valor devuelto distinto de cero indica un error.

Código de error	Significado
ERROR_INVALID_PARAMETER	Uno de los parámetros no era válido. Este error se devuelve si el parámetro InterfaceLuid o InterfaceAlias era NULL o si el parámetro InterfaceLuid no era válido.
ERROR_NOT_ENOUGH_MEMORY	No hay suficiente almacenamiento disponible para procesar este comando. Este error se devuelve si el tamaño del búfer al que apunta el parámetro InterfaceAlias no era lo suficientemente grande como se especifica en el parámetro Length para contener el nombre del alias.

Comentarios

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

La función ConvertInterfaceLuidToAlias es independiente del protocolo y funciona con interfaces de red para el protocolo IPv6 e IPv4.

La longitud máxima del nombre de alias de una interfaz de red, 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 e 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 deben usarse 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 (include Iphlpapi.h)
Library	Iphlpapi.lib
Archivo DLL	Iphlpapi.dll