Função if_nametoindex (netioapi.h)

Artigo
03/05/2024

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

Sintaxe

IPHLPAPI_DLL_LINKAGE NET_IFINDEX NETIOAPI_API_ if_nametoindex(
  [in] PCSTR InterfaceName
);

Parâmetros

[in] InterfaceName

Um ponteiro para uma cadeia de caracteres ANSI terminada em NULL que contém o nome da interface.

Retornar valor

Em caso de êxito, if_nametoindex retorna o índice de interface local. Em caso de falha, zero é retornado.

Comentários

A função if_nametoindex está disponível no Windows Vista e posteriores.

A função if_nametoindex mapeia um nome de interface para seu índice correspondente. Essa função foi projetada como parte das extensões básicas de soquete 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_nametoindex é implementada para portabilidade de aplicativos com ambientes Unix, mas as funções ConvertInterface são preferenciais. A função if_nametoindex pode ser substituída por uma chamada para a função ConvertInterfaceNameToLuidA para converter o nome da interface ANSI em um NET_LUID seguido por uma chamada para ConvertInterfaceLuidToIndex para converter o NET_LUID para o índice de interface local.

Se a função if_nametoindex falhar e retornar zero, não será possível determinar um código de erro.

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