Função ConvertInterfaceLuidToAlias

Artigo
06/15/2023

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

Observação

A família de API ConvertInterfaceXxx enumera identificadores em todas as interfaces associadas ao TCP/IP, que podem incluir miniportos virtuais, filtros leves, adaptadores de túnel e interfaces físicas.

Sintaxe

NETIOAPI_API ConvertInterfaceLuidToAlias(
  _In_  const NET_LUID *InterfaceLuid,
  _Out_       PWSTR    InterfaceAlias,
  _In_        SIZE_T   Length
);

Parâmetros

InterfaceLuid [in]
Um ponteiro para uma união de NET_LUID para o adaptador de rede.
InterfaceAlias [out]
Um ponteiro para um buffer para manter a cadeia de caracteres Unicode terminada em NULL. Se ConvertInterfaceLuidToAlias retornar com êxito , InterfaceAlias conterá o nome do alias do adaptador de rede.
Comprimento [in]
O comprimento, por contagem de caracteres, do buffer para o qual o parâmetro InterfaceAlias aponta. Esse valor deve ser grande o suficiente para manter o nome do alias do adaptador de rede e o caractere NULL de terminação. O comprimento máximo permitido é NDIS_IF_MAX_STRING_SIZE + 1. Para obter mais informações sobre NDIS_IF_MAX_STRING_SIZE, consulte a seção Comentários a seguir.

Retornar valor

ConvertInterfaceLuidToAlias retornará STATUS_SUCCESS se a função for bem-sucedida. Se a função falhar, ConvertInterfaceLuidToAlias retornará um dos seguintes códigos de erro:

Código de retorno	Descrição
STATUS_INVALID_PARAMETER	Um dos parâmetros é inválido. ConvertInterfaceLuidToAlias retornará esse erro se InterfaceLuid ou InterfaceAlias for NULL ou se InterfaceLuid for inválido.
STATUS_NOT_ENOUGH_MEMORY	Não há armazenamento suficiente disponível. ConvertInterfaceLuidToAlias retornará esse erro se o tamanho do buffer para o qual o parâmetro InterfaceAlias aponta não for tão grande quanto especificado no parâmetro Length e, portanto, o buffer não puder conter o nome do alias.

Comentários

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

O comprimento máximo do nome do alias para um adaptador de rede, NDIS_IF_MAX_STRING_SIZE, sem o caractere NULL de terminação, é declarado no arquivo de cabeçalho Ntddndis.h . NDIS_IF_MAX_STRING_SIZE é definido como a constante IF_MAX_STRING_SIZE, que é definida no arquivo de cabeçalho Ifdef.h .

Observação

Os arquivos de cabeçalho Ntddndis.h e Ifdef.h são incluídos automaticamente no arquivo de cabeçalho Netioapi.h . Você nunca deve usar os arquivos de cabeçalho Ntddndis.h e Ifdef.h diretamente.

Requisitos

Plataforma de destino	Universal
Versão	Disponível no Windows Vista e versões posteriores dos sistemas operacionais Windows.
parâmetro	Netioapi.h (inclua Netioapi.h)
Biblioteca	Netio.lib
IRQL	PASSIVE_LEVEL