Skip to main content

Windows Dev Center

ConvertInterfaceAliasToLuid function

The ConvertInterfaceAliasToLuid function converts an interface alias name for a network interface to the locally unique identifier (LUID) for the interface.

Syntax


NETIO_STATUS WINAPI ConvertInterfaceAliasToLuid(
  _In_  const WCHAR     *InterfaceAlias,
  _Out_       PNET_LUID InterfaceLuid
);

Parameters

InterfaceAlias [in]

A pointer to a NULL-terminated Unicode string containing the alias name of the network interface.

InterfaceLuid [out]

A pointer to the NET_LUID for this interface.

Return value

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

Error codeMeaning
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 InterfaceAlias parameter was invalid.

 

Remarks

The ConvertInterfaceAliasToLuid function is available on Windows Vista and later.

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

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Netioapi.h (include Iphlpapi.h)

Library

Iphlpapi.lib

DLL

Iphlpapi.dll

See also

ConvertInterfaceGuidToLuid
ConvertInterfaceIndexToLuid
ConvertInterfaceLuidToAlias
ConvertInterfaceLuidToGuid
ConvertInterfaceLuidToIndex
ConvertInterfaceLuidToNameA
ConvertInterfaceLuidToNameW
ConvertInterfaceNameToLuidA
ConvertInterfaceNameToLuidW
if_indextoname
if_nametoindex
NET_LUID