The GetIpNetTable2 function retrieves the IP neighbor table on the local computer.
_NETIOAPI_SUCCESS_ NETIOAPI_API GetIpNetTable2( ADDRESS_FAMILY Family, PMIB_IPNET_TABLE2 *Table );
The address family to retrieve.
Possible values for the address family are listed in the Winsock2.h header file. Note that the values for the AF_ address family and PF_ protocol family constants are identical (for example, AF_INET and PF_INET), so either constant can be used.
On the Windows SDK released for Windows Vista and later, the organization of header files has changed and possible values for this member are defined in the Ws2def.h header file. Note that the Ws2def.h header file is automatically included in Winsock2.h, and should never be used directly.
The values currently supported are AF_INET, AF_INET6, and AF_UNSPEC.
A pointer to a MIB_IPNET_TABLE2 structure that contains a table of neighbor IP address entries on the local computer.
If the function succeeds, the return value is NO_ERROR or ERROR_NOT_FOUND.
If the function fails or returns no data, the return value is one of the following error codes.
||An invalid parameter was passed to the function. This error is returned if a NULL pointer is passed in the Table parameter or the Family parameter was not specified as AF_INET, AF_INET6, or AF_UNSPEC.|
||Insufficient memory resources are available to complete the operation.|
No neighbor IP address entries as specified in the Family parameter were found.
This return value indicates that the call to the GetIpNetTable2 function succeeded, but there was no data to return. This can occur when AF_INET is specified in the Family parameter and there are no ARP entries to return.
The request is not supported.
This error is returned if no IPv4 stack is on the local computer and AF_INET was specified in the Family parameter. This error is also returned if no IPv6 stack is on the local computer and AF_INET6 was specified in the Family parameter. This error is also returned on versions of Windows where this function is not supported.
||Use FormatMessage to obtain the message string for the returned error.|
The GetIpNetTable2 function is defined on Windows Vista and later.
GetIpNetTable2 function enumerates the neighbor IP addresses on a local system and returns this information in a MIB_IPNET_TABLE2 structure.
The neighbor IP address entries are returned in a MIB_IPNET_TABLE2 structure in the buffer pointed to by the Table parameter. The MIB_IPNET_TABLE2 structure contains a neighbor IP address entry count and an array of MIB_IPNET_ROW2 structures for each neighbor IP address entry. When these returned structures are no longer required, free the memory by calling the FreeMibTable.
The Family parameter must be initialized to either AF_INET, AF_INET6, or AF_UNSPEC.
Note that the returned MIB_IPNET_TABLE2 structure pointed to by the Table parameter may contain padding for alignment between the NumEntries member and the first MIB_IPNET_ROW2 array entry in the Table member of the MIB_IPNET_TABLE2 structure. Padding for alignment may also be present between the MIB_IPNET_ROW2 array entries. Any access to a MIB_IPNET_ROW2 array entry should assume padding may exist.
The following example retrieves the IP neighbor table, then prints the values for IP neighbor row entries in the table.
#ifndef WIN32_LEAN_AND_MEAN #define WIN32_LEAN_AND_MEAN #endif
|Minimum supported client||Windows Vista [desktop apps only]|
|Minimum supported server||Windows Server 2008 [desktop apps only]|
|Header||netioapi.h (include Iphlpapi.h)|