ConvertInterfaceIndexToLuid function (netioapi.h)

Article
10/13/2021

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

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceIndexToLuid(
  [in]  NET_IFINDEX InterfaceIndex,
  [out] PNET_LUID   InterfaceLuid
);

Parameters

[in] InterfaceIndex

The local index value for a network interface.

[out] InterfaceLuid

A pointer to the NET_LUID for this interface.

Return value

On success, ConvertInterfaceIndexToLuid returns NO_ERROR. Any nonzero return value indicates failure and a NULL is returned in the InterfaceLuid parameter.

Error code	Meaning
ERROR_FILE_NOT_FOUND	The system cannot find the file specified. This error is returned if the network interface specified by the InterfaceIndex parameter was not a value on the local machine.
ERROR_INVALID_PARAMETER	One of the parameters was invalid. This error is returned if the InterfaceLuid parameter was NULL or if the InterfaceIndex parameter was invalid.

Remarks

The ConvertInterfaceIndexToLuid function is available on Windows Vista and later.

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

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