função if_indextoname (netioapi.h)

Artigo
03/13/2024

A função if_indextoname converte o índice local de um adaptador de rede para o nome da interface ANSI.

Sintaxe

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

Parâmetros

[in] InterfaceIndex

O índice local de um adaptador de rede.

[out] InterfaceName

Um ponteiro para um buffer para manter a cadeia de caracteres ANSI terminada em NULL que contém o nome da interface quando a função retorna com êxito. O comprimento, em bytes, do buffer apontado por esse parâmetro deve ser igual ou maior que IF_NAMESIZE.

Retornar valor

Em caso de êxito, if_indextoname retorna um ponteiro para a cadeia de caracteres ANSI terminada em NULL que contém o nome da interface. Em caso de falha, um ponteiro NULL é retornado.

Comentários

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

A função if_indextoname mapeia um índice de interface para seu nome correspondente. Essa função foi projetada como parte das extensões de soquete básicas para IPv6, conforme descrito pelo IETF no RFC 2553. Para obter mais informações, consulte http://www.ietf.org/rfc/rfc2553.txt.

A função if_indextoname é implementada para portabilidade de aplicativos com ambientes Unix, mas as funções ConvertInterface são preferenciais. A função if_indextoname pode ser substituída por uma chamada para a função ConvertInterfaceIndexToLuid para converter um índice de interface em um NET_LUID seguido por uma chamada para ConvertInterfaceLuidToNameA para converter o NET_LUID para o nome da interface ANSI.

Se o if_indextoname falhar e retornar um ponteiro NULL , não será possível determinar um código de erro.

O comprimento, em bytes, do buffer apontado pelo parâmetro InterfaceName deve ser igual ou maior que IF_NAMESIZE, um valor declarado no arquivo de cabeçalho Netioapi.h igual a NDIS_IF_MAX_STRING_SIZE. O comprimento máximo de um nome de interface, NDIS_IF_MAX_STRING_SIZE, sem o nulo 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