Função ConvertInterfaceLuidToAlias (netioapi.h)

Artigo
08/25/2023

A função ConvertInterfaceLuidToAlias converte um LUID (identificador local exclusivo) para um adaptador de rede em um alias de interface.

Sintaxe

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

Parâmetros

[in] InterfaceLuid

Um ponteiro para um NET_LUID para um adaptador de rede.

[out] InterfaceAlias

Um ponteiro para um buffer para manter a cadeia de caracteres Unicode terminada em NULL que contém o nome do alias do adaptador de rede quando a função retorna com êxito.

[in] Length

O comprimento, em caracteres, do buffer apontado pelo parâmetro InterfaceAlias . Esse valor deve ser grande o suficiente para acomodar o nome do alias do adaptador de rede e o caractere NULL de terminação. O comprimento máximo necessário é NDIS_IF_MAX_STRING_SIZE + 1.

Retornar valor

Em caso de êxito, ConvertInterfaceLuidToAlias retorna NO_ERROR. Qualquer valor retornado diferente de zero indica falha.

Código do erro	Significado
ERROR_INVALID_PARAMETER	Um dos parâmetros era inválido. Esse erro será retornado se o parâmetro InterfaceLuid ou InterfaceAlias for NULL ou se o parâmetro InterfaceLuid for inválido.
ERROR_NOT_ENOUGH_MEMORY	Não há armazenamento suficiente disponível para processar esse comando. Esse erro será retornado se o tamanho do buffer apontado pelo parâmetro InterfaceAlias não for grande o suficiente, conforme especificado no parâmetro Length para conter o nome do alias.

Comentários

A função ConvertInterfaceLuidToAlias está disponível no Windows Vista e posterior.

A função ConvertInterfaceLuidToAlias é independente de protocolo e funciona com adaptadores de rede para o protocolo IPv6 e IPv4.

O comprimento máximo do nome do alias para um adaptador de rede, NDIS_IF_MAX_STRING_SIZE, sem o NULL de terminação é declarado no arquivo de cabeçalho Ntddndis.h . O NDIS_IF_MAX_STRING_SIZE é definido como a constante IF_MAX_STRING_SIZE definida no arquivo de cabeçalho Ifdef.h . Os arquivos de cabeçalho Ntddndis.h e Ifdef.h são incluídos automaticamente no arquivo de cabeçalho Netioapi.h , que é incluído automaticamente pelo arquivo de cabeçalho Iphlpapi.h . Os arquivos de cabeçalho Ntddndis.h, Ifdef.h e Netioapi.h nunca devem ser usados diretamente.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	netioapi.h (inclua Iphlpapi.h)
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll