Função GetIfEntry2Ex (netioapi.h)

Artigo
08/25/2023

A função GetIfEntry2Ex recupera o nível especificado de informações para a interface especificada no computador local.

Sintaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIfEntry2Ex(
  [in]      MIB_IF_ENTRY_LEVEL Level,
  [in, out] PMIB_IF_ROW2       Row
);

Parâmetros

[in] Level

O nível de informações de interface a serem recuperadas. Esse parâmetro pode ser um dos valores do tipo de enumeração MIB_IF_ENTRY_LEVEL definido no arquivo de cabeçalho Netioapi.h .

Valor	Significado
MibIfEntryNormal 0	Os valores de estatísticas e estado retornados em membros da estrutura MIB_IF_ROW2 apontada pelo parâmetro Row são retornados da parte superior da pilha de filtros.
MibIfEntryNormalWithoutStatistics 2	Os valores de estado (sem estatísticas) retornados em membros da estrutura MIB_IF_ROW2 apontada pelo parâmetro Row são retornados da parte superior da pilha de filtros.

[in, out] Row

Um ponteiro para uma estrutura MIB_IF_ROW2 que, no retorno bem-sucedido, recebe informações de uma interface no computador local. Na entrada, o InterfaceLuid ou o membro InterfaceIndex do MIB_IF_ROW2 deve ser definido como a interface para a qual recuperar informações.

Retornar valor

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

Se a função falhar, o valor retornado será um dos códigos de erro a seguir.

Código de retorno	Descrição
ERROR_FILE_NOT_FOUND	O sistema não pode encontrar o arquivo especificado. Esse erro será retornado se o LUID da interface de rede ou o índice de interface especificado pelo membro InterfaceLuid ou InterfaceIndex do MIB_IF_ROW2 apontado pelo parâmetro Row não for um valor no computador local.
ERROR_INVALID_PARAMETER	Um parâmetro inválido foi passado para a função. Esse erro será retornado se um parâmetro NULL for passado no parâmetro Row . Esse erro também será retornado se o membro InterfaceLuid e InterfaceIndex do MIB_IF_ROW2 apontado pelo parâmetro Row não for especificado.
Outros	Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

O
A função GetIfEntry2Ex recupera informações para uma interface especificada em um sistema local e retorna essas informações em um ponteiro para um
MIB_IF_ROW2 estrutura. GetIfEntry2Ex é uma versão aprimorada da função GetIfEntry2 que permite selecionar o nível de informações de interface a serem recuperadas.

Na entrada, pelo menos um dos seguintes membros na estrutura MIB_IF_ROW2 passada no parâmetro Row deve ser inicializado: InterfaceLuid ou InterfaceIndex.

Os campos são usados na ordem listada acima. Portanto, se InterfaceLuid for especificado, esse membro será usado para determinar a interface. Se nenhum valor tiver sido definido para o membro InterfaceLuid (o valor desse membro foi definido como zero), o membro InterfaceIndex será usado em seguida para determinar a interface.

Na saída, os campos restantes da estrutura MIB_IF_ROW2 apontada pelo parâmetro Row são preenchidos.

Observe que o arquivo de cabeçalho Netioapi.h é incluído automaticamente no arquivo de cabeçalho Iphlpapi.h e nunca deve ser usado diretamente.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 10, versão 1703 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2016 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	netioapi.h (inclua Iphlpapi.h)
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll