Função GetAdapterIndex (iphlpapi.h)

Artigo
02/28/2024

A função GetAdapterIndex obtém o índice de um adaptador, considerando seu nome.

Sintaxe

IPHLPAPI_DLL_LINKAGE DWORD GetAdapterIndex(
  [in]      LPWSTR AdapterName,
  [in, out] PULONG IfIndex
);

Parâmetros

[in] AdapterName

Um ponteiro para uma cadeia de caracteres Unicode que especifica o nome do adaptador.

[in, out] IfIndex

Um ponteiro para uma variável ULONG que aponta para o índice do adaptador.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

Até que um adaptador esteja totalmente desabilitado, a função GetAdapterIndex relata o adaptador como presente. Por exemplo, a função NotifyAddrChange pode indicar que o endereço IP de um adaptador desabilitado recentemente foi removido, mas GetAdapterIndex continua relatando um índice de adaptador até que o processo de desabilitação do adaptador seja concluído.

Quando um ou mais adaptadores estão presentes no sistema, GetAdapterIndex retorna ERROR_DEV_NOT_EXIST quando o adaptador que está sendo consultado não existe. Quando nenhum adaptador está presente, a função GetAdapterIndex retorna ERROR_NO_DATA.

O índice do adaptador pode ser alterado quando um adaptador é desabilitado e, em seguida, habilitado ou em outras circunstâncias, e não deve ser considerado persistente.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	iphlpapi.h
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll