NdisIfGetNetLuidFromInterfaceIndex (Compact 2013)

3/26/2014

This function gets the NET_LUID value that is associated with a network interface index.

Syntax

NDIS_STATUS
  NdisIfGetNetLuidFromInterfaceIndex(
    IN NET_IFINDEX  IfIndex,
    OUT PNET_LUID  pNetLuid
    );

Parameters

• IfIndex
  A network interface index that NDIS assigned to a NET_LUID value in the NdisIfRegisterInterface function.

• pNetLuid
  A pointer to a caller-supplied NET_LUID variable. If NdisIfGetNetLuidFromInterfaceIndex succeeds, NDIS writes the NET_LUID value that is associated with the specified network interface index to this variable.

Return Value

NdisIfGetNetLuidFromInterfaceIndex returns one of the following status values:

Value	Description
NDIS_STATUS_SUCCESS	The operation completed successfully.
NDIS_STATUS_INTERFACE_NOT_FOUND	NdisIfGetNetLuidFromInterfaceIndex failed because the specified network interface index is not assigned to a registered interface.

Remarks

NDIS drivers can call the NdisIfGetNetLuidFromInterfaceIndex function to get the NET_LUID value that is associated with a network interface index.

For the interfaces that the NDIS proxy provider service manages, NDIS provides the interface index and NET_LUID in various driver initialization structures:

• Miniport drivers can obtain the interface index and NET_LUID for a miniport adapter in the NDIS_MINIPORT_INIT_PARAMETERS structure.
• Filter drivers can obtain the interface index and NET_LUID for a filter module in the NDIS_FILTER_ATTACH_PARAMETERS structure.
• Protocol drivers can obtain the interface index and NET_LUID of the highest and the lower interfaces on a driver stack in the NDIS_BIND_PARAMETERS structure.

NDIS assigns an interface index to a network interface when the interface provider calls the NdisIfRegisterInterface function. An interface provider calls the NDIS_MAKE_NET_LUIDmacro to create the NET_LUID value before it registers an interface.

The interface index value can change without a device restart. Deregistering and reregistering an interface that is associated with a NET_LUID value might result in different interface index values. Do not confuse the interface index with the NET_LUID index that persists after a device restarts.

NDIS provides the NdisIfGetInterfaceIndexFromNetLuid function to obtain the interface index for a specified NET_LUID.

Requirements

Header

ndis.h

See Also

Reference

NDIS Network Interface Functions
NDIS_BIND_PARAMETERS
NDIS_FILTER_ATTACH_PARAMETERS
NDIS_MAKE_NET_LUID
NDIS_MINIPORT_INIT_PARAMETERS
NdisIfGetInterfaceIndexFromNetLuid
NdisIfRegisterInterface

Other Resources

NET_LUID