Função GetIpNetTable (iphlpapi.h)

Artigo
03/05/2024

A função GetIpNetTable recupera o IPv4 para a tabela de mapeamento de endereço físico.

Sintaxe

IPHLPAPI_DLL_LINKAGE ULONG GetIpNetTable(
  [out]     PMIB_IPNETTABLE IpNetTable,
  [in, out] PULONG          SizePointer,
  [in]      BOOL            Order
);

Parâmetros

[out] IpNetTable

Um ponteiro para um buffer que recebe o IPv4 para a tabela de mapeamento de endereço físico como uma estrutura MIB_IPNETTABLE .

[in, out] SizePointer

Na entrada, especifica o tamanho em bytes do buffer apontado pelo parâmetro pIpNetTable .

Na saída, se o buffer não for grande o suficiente para manter a tabela de mapeamento retornada, a função definirá esse parâmetro como igual ao tamanho do buffer necessário em bytes.

[in] Order

Um valor booliano que especifica se a tabela de mapeamento retornada deve ser classificada em ordem crescente por endereço IP. Se esse parâmetro for TRUE, a tabela será classificada.

Retornar valor

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

Se a função falhar ou não retornar dados, o valor retornado será um dos seguintes códigos de erro.

Código de retorno	Descrição
ERROR_INSUFFICIENT_BUFFER	O buffer apontado pelo parâmetro pIpNetTable não é grande o suficiente. O tamanho necessário é retornado na variável DWORD apontada pelo parâmetro pdwSize .
ERROR_INVALID_PARAMETER	Um parâmetro inválido foi passado para a função. Esse erro será retornado se o parâmetro pdwSize for NULL ou GetIpNetTable não puder gravar na memória apontada pelo parâmetro pdwSize .
ERROR_NO_DATA	Não há dados a serem retornados. A tabela de mapeamento IPv4 para endereço físico está vazia. Esse valor retornado indica que a chamada para a função GetIpNetTable foi bem-sucedida, mas não havia dados a serem retornados.
ERROR_NOT_SUPPORTED	O transporte IPv4 não está configurado no computador local.
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

O
A função GetIpNetTable enumera as entradas do Protocolo de Resolução de Endereços (ARP) para IPv4 em um sistema local do IPv4 para a tabela de mapeamento de endereço físico e retorna essas informações em uma estrutura MIB_IPNETTABLE.

As entradas de endereço IPv4 são retornadas em uma estrutura MIB_IPNETTABLE no buffer apontado pelo parâmetro pIpNetTable . A estrutura MIB_IPNETTABLE contém uma contagem de entradas ARP e uma matriz de estruturas MIB_IPNETROW para cada entrada de endereço IPv4.

Observe que a estrutura de MIB_IPNETTABLE retornada apontada pelo parâmetro pIpNetTable pode conter preenchimento para alinhamento entre o membro dwNumEntries e a primeira entrada de matriz MIB_IPNETROW no membro da tabela da estrutura MIB_IPNETTABLE . O preenchimento para alinhamento também pode estar presente entre as entradas da matriz MIB_IPNETROW . Qualquer acesso a uma entrada de matriz MIB_IPNETROW deve assumir que o preenchimento pode existir.

No Windows Vista e posterior, a função GetIpNetTable2 pode ser usada para recuperar os endereços IP vizinhos para IPv6 e IPv4.

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