ConvertInterfaceGuidToLuid function (netioapi.h)

Article
02/22/2024

The ConvertInterfaceGuidToLuid function converts a globally unique identifier (GUID) for a network interface to the locally unique identifier (LUID) for the interface.

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceGuidToLuid(
  [in]  const GUID *InterfaceGuid,
  [out] PNET_LUID  InterfaceLuid
);

Parameters

[in] InterfaceGuid

A pointer to a GUID for a network interface.

[out] InterfaceLuid

A pointer to the NET_LUID for this interface.

Return value

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

Error code	Meaning
ERROR_INVALID_PARAMETER	One of the parameters was invalid. This error is returned if either the InterfaceAlias or InterfaceLuid parameter was NULL or if the InterfaceGuid parameter was invalid.

Remarks

The ConvertInterfaceGuidToLuid function is available on Windows Vista and later.

The ConvertInterfaceGuidToLuid 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