Share via

GetIpInterfaceTable (NETIOAPI) (Compact 2013)

  • Article

3/26/2014

This function retrieves the IP interface entries on a 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). Therefore, you can use either constant.

    Possible values for the Family parameter are defined in the Ws2def.h header file. Be aware that the Ws2def.h header file is automatically included in Netioapi.h and you should never use Ws2def.h directly.

    The following values are currently supported for the address family:

    • AF_UNSPEC
      The address family is unspecified. When this value is specified, the GetIpInterfaceTable function returns the IP interface table that contains both IPv4 and IPv6 entries.
    • AF_INET
      The IPv4 address family.
    • AF_INET6
      The 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

Error Code

Meaning

STATUS_SUCCESS

The function succeeds.

STATUS_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.

STATUS_NOT_ENOUGH_MEMORY

Insufficient memory resources are available to complete the operation.

STATUS_NOT_FOUND

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

STATUS_NOT_SUPPORTED

The function is not supported. This error is returned when the IP transport that is 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 device and returns this information in an MIB_IPINTERFACE_TABLE structure.

GetIpInterfaceTable returns IP interface entries in a MIB_IPINTERFACE_TABLE structure in the buffer that the Table parameter points to. 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, your driver should free the memory by calling the FreeMibTable (NETIOAPI) function.

Your driver must initialize the Family parameter to either AF_INET or AF_INET6.

Be aware that the returned MIB_IPINTERFACE_TABLE structure that the Table parameter points to might 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 might also be present between the MIB_IPINTERFACE_ROW array entries. Any access to a MIB_IPINTERFACE_ROW array entry should assume padding might exist.

See Also

Reference

IP Helper Kernel-Mode Functions
FreeMibTable (NETIOAPI)
MIB_IPINTERFACE_ROW
MIB_IPINTERFACE_TABLE
MIB_IPNET_ROW2
MIB_IPNET_TABLE2