Função GetIfStackTable (netioapi.h)

Artigo
02/29/2024

A função GetIfStackTable recupera uma tabela de entradas de linha de pilha de interface de rede que especificam a relação dos adaptadores de rede em uma pilha de interfaces.

Sintaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIfStackTable(
  [out] PMIB_IFSTACK_TABLE *Table
);

Parâmetros

[out] Table

Um ponteiro para um buffer que recebe a tabela de entradas de linha de pilha de interface em uma estrutura MIB_IFSTACK_TABLE .

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 seguintes códigos de erro.

Código de retorno	Descrição
ERROR_INVALID_PARAMETER	Um parâmetro inválido foi passado para a função. Esse erro será retornado se um ponteiro NULL for passado no parâmetro Table .
ERROR_NOT_ENOUGH_MEMORY	Recursos de memória insuficientes estão disponíveis para concluir a operação.
ERROR_NOT_FOUND	Nenhuma entrada de pilha de interface foi encontrada.
Outros	Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função GetIfStackTable é definida no Windows Vista e posteriores.

O
A função GetIfStackTable enumera as interfaces de rede física e lógica em uma pilha de interface em um sistema local e retorna essas informações em uma estrutura de MIB_IFSTACK_TABLE.

As entradas de pilha de interface são retornadas em uma estrutura MIB_IFSTACK_TABLE no buffer apontado pelo parâmetro Table . A estrutura MIB_IFSTACK_TABLE contém uma contagem de entradas de pilha de interface e uma matriz de estruturas de MIB_IFSTACK_ROW para cada entrada de pilha de interface.

A relação entre as interfaces na pilha de interface é que a interface com o índice no membro HigherLayerInterfaceIndex da estrutura MIB_IFSTACK_ROW está imediatamente acima da interface com o índice no membro LowerLayerInterfaceIndex da estrutura MIB_IFSTACK_ROW .

A memória é alocada pela função GetIfStackTable para a estrutura MIB_IFSTACK_TABLE e as entradas MIB_IFSTACK_ROW nessa estrutura. Quando essas estruturas retornadas não forem mais necessárias, libere a memória chamando FreeMibTable.

Observe que a estrutura de MIB_IFSTACK_TABLE retornada apontada pelo parâmetro Table pode conter preenchimento para alinhamento entre o membro NumEntries e a primeira entrada de matriz MIB_IFSTACK_ROW no membro Table da estrutura MIB_IFSTACK_TABLE . O preenchimento para alinhamento também pode estar presente entre as entradas da matriz MIB_IFSTACK_ROW . Qualquer acesso a uma entrada de matriz MIB_IFSTACK_ROW deve pressupor que o preenchimento possa existir.

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