ConvertInterfaceLuidToAlias function

Article
03/03/2023

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

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 ConvertInterfaceLuidToAlias(
  _In_  const NET_LUID *InterfaceLuid,
  _Out_       PWSTR    InterfaceAlias,
  _In_        SIZE_T   Length
);

Parameters

InterfaceLuid [in]
A pointer to a NET_LUID union for the network interface.
InterfaceAlias [out]
A pointer to a buffer to hold the NULL-terminated Unicode string. If ConvertInterfaceLuidToAlias returns successfully, InterfaceAlias contains the alias name of the network interface.
Length [in]
The length, by character count, of the buffer that the InterfaceAlias parameter points to. This value must be large enough to hold the alias name of the network interface and the terminating NULL character. The maximum allowed length is NDIS_IF_MAX_STRING_SIZE + 1. For more information about NDIS_IF_MAX_STRING_SIZE, see the following Remarks section.

Return value

ConvertInterfaceLuidToAlias returns STATUS_SUCCESS if the function succeeds. If the function fails, ConvertInterfaceLuidToAlias returns one of the following error codes:

Return code	Description
STATUS_INVALID_PARAMETER	One of the parameters is invalid. ConvertInterfaceLuidToAlias returns this error if either InterfaceLuid or InterfaceAlias is NULL, or if InterfaceLuid is invalid.
STATUS_NOT_ENOUGH_MEMORY	Not enough storage is available. ConvertInterfaceLuidToAlias returns this error if the size of the buffer that the InterfaceAlias parameter points to was not as large as specified in the Length parameter and, therefore, the buffer could not hold the alias name.

Remarks

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

The maximum length of the alias name for a network interface, NDIS_IF_MAX_STRING_SIZE, without the terminating NULL character, is declared in the Ntddndis.h header file. NDIS_IF_MAX_STRING_SIZE is defined to be the IF_MAX_STRING_SIZE constant, which is defined in the Ifdef.h header file.

Note

The Ntddndis.h and Ifdef.h header files are automatically included in the Netioapi.h header file. You should never use the Ntddndis.h and Ifdef.h header files directly.

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