Função ConvertInterfaceNameToLuidA

Artigo
06/15/2023

A função ConvertInterfaceNameToLuidA converte um nome de adaptador de rede ANSI para o LUID (identificador exclusivo local) para a 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 ConvertInterfaceNameToLuidA(
  _In_  const CHAR     *InterfaceName,
  _Out_       NET_LUID *InterfaceLuid
);

Parâmetros

InterfaceName [in]
Um ponteiro para uma cadeia de caracteres ANSI terminada em NULL que contém o nome do adaptador de rede.
InterfaceLuid [out]
Um ponteiro para a união NET_LUID para essa interface.

Retornar valor

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

Código de retorno	Descrição
ERROR_BUFFER_OVERFLOW	O comprimento do nome da interface ANSI é inválido. ConvertInterfaceNameToLuidA retornará esse erro se o parâmetro InterfaceName exceder o comprimento máximo de cadeia de caracteres permitido para esse parâmetro.
STATUS_INVALID_NAME	O nome da interface é inválido. ConvertInterfaceNameToLuidA retornará esse erro se o parâmetro InterfaceName contiver um nome de interface inválido.
STATUS_INVALID_PARAMETER	Um dos parâmetros é inválido. ConvertInterfaceNameToLuidA retornará esse erro se o parâmetro InterfaceLuid for NULL.

Comentários

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

O comprimento máximo do nome do adaptador de rede, NDIS_IF_MAX_STRING_SIZE, sem o NULL de terminação, é definido 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.

Use a função ConvertInterfaceNameToLuidW para converter um nome de interface Unicode em um LUID.

Requisitos

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