GetInvertedIfStackTable function (netioapi.h)

Article
10/13/2021

The GetInvertedIfStackTable function retrieves a table of inverted network interface stack row entries that specify the relationship of the network interfaces on an interface stack.

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetInvertedIfStackTable(
  [out] PMIB_INVERTEDIFSTACK_TABLE *Table
);

Parameters

[out] Table

A pointer to a buffer that receives the table of inverted interface stack row entries in a MIB_INVERTEDIFSTACK_TABLE structure.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Return code	Description
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.
ERROR_NOT_ENOUGH_MEMORY	Insufficient memory resources are available to complete the operation.
ERROR_NOT_FOUND	No interface stack entries were found.
Other	Use the FormatMessage function to obtain the message string for the returned error.

Remarks

The GetInvertedIfStackTable function is defined on Windows Vista and later.

The
GetInvertedIfStackTable function enumerates the physical and logical network interfaces on an interface stack on a local system and returns this information in an inverted form in the MIB_INVERTEDIFSTACK_TABLE structure.

Interface stack entries are returned in a MIB_INVERTEDIFSTACK_TABLE structure in the buffer pointed to by the Table parameter. The MIB_INVERTEDIFSTACK_TABLE structure contains an interface stack entry count and an array of MIB_INVERTEDIFSTACK_ROW structures for each interface stack entry.

The relationship between the interfaces in the interface stack is that the interface with index in the HigherLayerInterfaceIndex member of the MIB_INVERTEDIFSTACK_ROW structure is immediately above the interface with index in the LowerLayerInterfaceIndex member of the MIB_INVERTEDIFSTACK_ROW structure.

Memory is allocated by the GetInvertedIfStackTable function for the MIB_INVERTEDIFSTACK_TABLE structure and the MIB_INVERTEDIFSTACK_ROW entries in this structure. When these returned structures are no longer required, free the memory by calling the FreeMibTable.

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

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	netioapi.h (include Iphlpapi.h)
Library	Iphlpapi.lib
DLL	Iphlpapi.dll