ConvertInterfaceIndexToLuid function

The ConvertInterfaceIndexToLuid function converts a local index for a network interface to the locally unique identifier (LUID) for the interface.

Note  The ConvertInterfaceXxx API family enumerates identifiers over all interfaces bound to TCP/IP, which may include virtual miniports, lightweight filters, tunnel adapters, and physical interfaces.
 

Syntax


NETIOAPI_API ConvertInterfaceIndexToLuid(
  _In_  NET_IFINDEX InterfaceIndex,
  _Out_ PNET_LUID   InterfaceLuid
);

Parameters

InterfaceIndex [in]

The local index value for the network interface.

InterfaceLuid [out]

A pointer to the NET_LUID union for the network interface.

Return value

ConvertInterfaceIndexToLuid returns STATUS_SUCCESS if the function succeeds. If the function fails, the InterfaceLuid parameter is set to NULL, and ConvertInterfaceIndexToLuid returns the following error code:

Return codeDescription
STATUS_INVALID_PARAMETER

One of the parameters was invalid. ConvertInterfaceIndexToLuid returns this error if the InterfaceLuid parameter is NULL, or if the InterfaceIndex parameter is invalid.

 

Remarks

The ConvertInterfaceIndexToLuid function is protocol-independent and works with network interfaces for both the IPv6 and IPv4 protocols.

Requirements

Target platform

Universal

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

Netioapi.h (include Netioapi.h)

Library

Netio.lib

IRQL

PASSIVE_LEVEL

See also

ConvertInterfaceAliasToLuid
ConvertInterfaceGuidToLuid
ConvertInterfaceLuidToGuid
ConvertInterfaceLuidToIndex
ConvertInterfaceLuidToNameA
ConvertInterfaceLuidToNameW
ConvertInterfaceNameToLuidA
ConvertInterfaceNameToLuidW
NET_LUID

 

 

Send comments about this topic to Microsoft

Show: