ConvertInterfaceAliasToLuid - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// netioapi.h
NETIOAPI_API ConvertInterfaceAliasToLuid(
_In_ const WCHAR *InterfaceAlias,
_Out_ PNET_LUID InterfaceLuid
);
View the official Windows hardware development documentationNo description available.
The ConvertInterfaceAliasToLuid function converts an interface alias name for a network interface 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.
InterfaceAlias [in] A pointer to a NULL-terminated Unicode string that contains the alias name of the network interface.
InterfaceLuid [out] A pointer to the NET_LUID union for the network interface.
ConvertInterfaceAliasToLuid returns STATUS_SUCCESS if the function succeeds. If the function fails, the InterfaceLuid parameter is set to NULL, and ConvertInterfaceAliasToLuid returns the following error code:
| Return code | Description |
|---|---|
| STATUS_INVALID_PARAMETER | One of the parameters was invalid. ConvertInterfaceAliasToLuid returns this error if either InterfaceAlias or InterfaceLuid is NULL, or if InterfaceAlias is invalid. |
The ConvertInterfaceAliasToLuid function is protocol-independent and works with network interfaces for both the IPv6 and IPv4 protocols.
| 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 |