ConvertInterfaceNameToLuidA function
The ConvertInterfaceNameToLuidA function converts an ANSI network interface name to the locally unique identifier (LUID) for the interface.
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 ConvertInterfaceNameToLuidA(
_In_ const CHAR *InterfaceName,
_Out_ NET_LUID *InterfaceLuid
);
Parameters
InterfaceName [in]
A pointer to a NULL-terminated ANSI string that contains the network interface name.InterfaceLuid [out]
A pointer to the NET_LUID union for this interface.
Return value
ConvertInterfaceNameToLuidA returns STATUS_SUCCESS if the function succeeds. If the function fails, ConvertInterfaceNameToLuidA returns one of the following error codes:
| Return code | Description |
|---|---|
| ERROR_BUFFER_OVERFLOW | The length of the ANSI interface name is invalid. ConvertInterfaceNameToLuidA returns this error if the InterfaceName parameter exceeds the maximum allowed string length for this parameter. |
| STATUS_INVALID_NAME | The interface name is invalid. ConvertInterfaceNameToLuidA returns this error if the InterfaceName parameter contains an invalid interface name. |
| STATUS_INVALID_PARAMETER | One of the parameters is invalid. ConvertInterfaceNameToLuidA returns this error if the InterfaceLuid parameter is NULL. |
Remarks
The ConvertInterfaceNameToLuidA function is protocol-independent and works with network interfaces for both the IPv6 and IPv4 protocols.
The maximum length of the network interface name, NDIS_IF_MAX_STRING_SIZE, without the terminating NULL, 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 ConvertInterfaceNameToLuidW function to convert a Unicode interface name to a LUID.
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 |