Skip to content

Latest commit

 

History

History
192 lines (126 loc) · 6.66 KB

nf-netioapi-getinvertedifstacktable.md

File metadata and controls

192 lines (126 loc) · 6.66 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:netioapi.GetInvertedIfStackTable
GetInvertedIfStackTable function (netioapi.h)
Retrieves a table of inverted network interface stack row entries that specify the relationship of the network interfaces on an interface stack.
GetInvertedIfStackTable
GetInvertedIfStackTable function [IP Helper]
iphlp.getinvertedifstacktable
netioapi/GetInvertedIfStackTable
iphlp\getinvertedifstacktable.htm
IpHlp
d1808ded-2798-46cc-8021-fdbcd3da60ea
12/05/2018
GetInvertedIfStackTable, GetInvertedIfStackTable function [IP Helper], iphlp.getinvertedifstacktable, netioapi/GetInvertedIfStackTable
netioapi.h
Iphlpapi.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Iphlpapi.lib
Iphlpapi.dll
Windows
19H1
GetInvertedIfStackTable
netioapi/GetInvertedIfStackTable
c++
APIRef
kbSyntax
DllExport
Iphlpapi.dll
GetInvertedIfStackTable

GetInvertedIfStackTable function

-description

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.

-parameters

-param Table [out]

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

-returns

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.

-see-also

FreeMibTable

GetIfEntry2

GetIfStackTable

GetIfTable2

GetIpInterfaceEntry

InitializeIpInterfaceEntry

MIB_IFSTACK_ROW

MIB_IFSTACK_TABLE

MIB_IF_ROW2

MIB_IF_TABLE2

MIB_INVERTEDIFSTACK_ROW

MIB_INVERTEDIFSTACK_TABLE

MIB_IPINTERFACE_ROW

NotifyIpInterfaceChange

SetIpInterfaceEntry