GetIpInterfaceTable (Compact 2013)

  • Article

3/26/2014

This function retrieves the IP interface entries on the local device.

Syntax

NETIOAPI_API  GetIpInterfaceTable(
  __in   ADDRESS_FAMILY  Family,
  __out  PMIB_IPINTERFACE_TABLE* Table
);

Parameters

  • Family
    The address family of IP interfaces to retrieve.

    Possible values for the address family are listed in the Winsock2.h header file. Be aware that the values for the AF_ address family and PF_ protocol family constants are identical (for example, AF_INET and PF_INET) so that either constant can be used.

    The header file organization has changed and possible values for this member are defined in the Ws2def.h header file. Be aware 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:

    Value

    Meaning

    AF_UNSPEC

    0

    The address family is unspecified. When this parameter is specified, the GetIpInterfaceTable function returns the IP interface table that contains both IPv4 and IPv6 entries.

    AF_INET

    2

    The IP version 4 (IPv4) address family.

    AF_INET6

    23

    The IP version 6 (IPv6) address family.
  • Table
    A pointer to a buffer that receives the table of IP interface entries in a MIB_IPINTERFACE_TABLE structure.

Return Value

Return code

Description

NO_ERROR

The function succeeds.

ERROR_INVALID_PARAMETER

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.

ERROR_NOT_ENOUGH_MEMORY

Insufficient memory resources are available to complete the operation.

ERROR_NOT_FOUND

No IP interface entries as specified in the Family parameter were found.

ERROR_NOT_SUPPORTED

The function is not supported. This error is returned when the IP transport specified in the Address parameter is not configured on the local device. This error is also returned on versions of Windows where this function is not supported.

Other

Use the FormatMessage function to obtain the message string for the returned error.

Remarks

The GetIpInterfaceTable function enumerates the IP interfaces on a local system and returns this information in an MIB_IPINTERFACE_TABLE structure.

IP interface entries are returned in a MIB_IPINTERFACE_TABLE structure in the buffer pointed to by the Table parameter. The MIB_IPINTERFACE_TABLE structure contains an IP interface entry count and an array of MIB_IPINTERFACE_ROW structures for each IP interface 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 or AF_INET6.

Be aware that the returned MIB_IPINTERFACE_TABLE structure pointed to by the Table parameter may contain padding for alignment between the NumEntries member and the first MIB_IPINTERFACE_ROW array entry in the Table member of the MIB_IPINTERFACE_TABLE structure. Padding for alignment may also be present between the MIB_IPINTERFACE_ROW array entries. Any access to a MIB_IPINTERFACE_ROW array entry should assume padding may exist.

See Also

Reference

IP Helper Functions
FreeMibTable
GetIfEntry2
GetIfStackTable
GetIfTable2
GetInvertedIfStackTable
GetIpInterfaceEntry
InitializeIpInterfaceEntry
MIB_IF_ROW2
MIB_IF_TABLE2
MIB_IPINTERFACE_ROW
MIB_IPINTERFACE_TABLE
NotifyIpInterfaceChange

Other Resources

IP Helper