GetIpNetTable, fonction (iphlpapi.h)

Article
08/24/2023

La fonction GetIpNetTable récupère la table de mappage d’adresses IPv4 à physique.

Syntaxe

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

Paramètres

[out] IpNetTable

Pointeur vers une mémoire tampon qui reçoit la table de mappage d’adresses physiques IPv4 en tant que structure de MIB_IPNETTABLE .

[in, out] SizePointer

Lors de l’entrée, spécifie la taille en octets de la mémoire tampon vers laquelle pointe le paramètre pIpNetTable .

Sur la sortie, si la mémoire tampon n’est pas assez grande pour contenir la table de mappage retournée, la fonction définit ce paramètre comme étant la taille de mémoire tampon requise en octets.

[in] Order

Valeur booléenne qui spécifie si la table de mappage retournée doit être triée dans l’ordre croissant par adresse IP. Si ce paramètre a la valeur TRUE, la table est triée.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR ou ERROR_NO_DATA.

Si la fonction échoue ou ne retourne aucune donnée, la valeur de retour est l’un des codes d’erreur suivants.

Code de retour	Description
ERROR_INSUFFICIENT_BUFFER	La mémoire tampon pointée par le paramètre pIpNetTable n’est pas suffisamment grande. La taille requise est retournée dans la variable DWORD pointée vers le paramètre pdwSize .
ERROR_INVALID_PARAMETER	Un paramètre non valide a été transmis à la fonction. Cette erreur est retournée si le paramètre pdwSize a la valeur NULL ou si GetIpNetTable ne peut pas écrire dans la mémoire pointée par le paramètre pdwSize .
ERROR_NO_DATA	Il n’y a aucune donnée à retourner. La table de mappage d’adresses IPv4 à physique est vide. Cette valeur de retour indique que l’appel à la fonction GetIpNetTable a réussi, mais qu’il n’y avait aucune donnée à retourner.
ERROR_NOT_SUPPORTED	Le transport IPv4 n’est pas configuré sur l’ordinateur local.
Autres	Utilisez FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Remarques

The
La fonction GetIpNetTable énumère les entrées ARP (Address Resolution Protocol) pour IPv4 sur un système local de la table de mappage d’adresses IPv4 à la table de mappage d’adresses physiques et retourne ces informations dans une structure MIB_IPNETTABLE.

Les entrées d’adresse IPv4 sont retournées dans une structure MIB_IPNETTABLE dans la mémoire tampon vers laquelle pointe le paramètre pIpNetTable . La structure MIB_IPNETTABLE contient un nombre d’entrées ARP et un tableau de structures MIB_IPNETROW pour chaque entrée d’adresse IPv4.

Notez que la structure de MIB_IPNETTABLE retournée pointée par le paramètre pIpNetTable peut contenir un remplissage pour l’alignement entre le membre dwNumEntries et la première entrée de tableau MIB_IPNETROW dans le membre de table de la structure MIB_IPNETTABLE . Un remplissage pour l’alignement peut également être présent entre les entrées de tableau MIB_IPNETROW . Tout accès à une entrée de tableau MIB_IPNETROW doit supposer qu’un remplissage peut exister.

sur Windows Vista et versions ultérieures, la fonction GetIpNetTable2 peut être utilisée pour récupérer les adresses IP voisines pour IPv6 et IPv4.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	iphlpapi.h
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll