ConvertInterfaceLuidToNameA function

Article
03/03/2023

The ConvertInterfaceLuidToNameA function converts a locally unique identifier (LUID) for a network interface to the ANSI interface name.

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 ConvertInterfaceLuidToNameA(
  _In_  const NET_LUID *InterfaceLuid,
  _Out_       PSTR     InterfaceName,
  _In_        SIZE_T   Length
);

Parameters

InterfaceLuid [in]
A pointer to a NET_LUID union for a network interface.
InterfaceName [out]
A pointer to a buffer to hold the NULL-terminated ANSI string. If ConvertInterfaceLuidToNameA returns successfully, InterfaceName contains the ANSI interface name.
Length [in]
The length, in bytes, of the buffer that the InterfaceName parameter points to. This value must be large enough to hold the interface name 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

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

Return code	Description
STATUS_INVALID_PARAMETER	One of the parameters is invalid. ConvertInterfaceLuidToNameA returns this error if either InterfaceLuid or InterfaceName is NULL, or if InterfaceLuid is invalid.
STATUS_NOT_ENOUGH_MEMORY	ConvertInterfaceLuidToNameA returns this error if the InterfaceName buffer was not as large as specified in the Length parameter and, therefore, the buffer could not hold the interface name.

Remarks

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

The maximum length of the name for a network interface, NDIS_IF_MAX_STRING_SIZE, without the terminating NULL character, is defined 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.

Use the ConvertInterfaceLuidToNameW function to convert a network interface LUID to a Unicode interface name.

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