ConvertInterfaceAliasToLuid function
The ConvertInterfaceAliasToLuid function converts an interface alias name for a network interface to the locally unique identifier (LUID) for the interface.
Syntax
NETIOAPI_API ConvertInterfaceAliasToLuid(
_In_ const WCHAR *InterfaceAlias,
_Out_ PNET_LUID InterfaceLuid
);
Parameters
- 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.
Return value
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 |
|---|---|
|
One of the parameters was invalid. ConvertInterfaceAliasToLuid returns this error if either InterfaceAlias or InterfaceLuid is NULL, or if InterfaceAlias is invalid. |
Remarks
The ConvertInterfaceAliasToLuid function is protocol-independent and works with network interfaces for both the IPv6 and IPv4 protocols.
Requirements
|
Target platform | |
|---|---|
|
Version |
Available in Windows Vista and later versions of the Windows operating systems. |
|
Header |
|
|
Library |
|
|
IRQL |
PASSIVE_LEVEL |
See also
- ConvertInterfaceGuidToLuid
- ConvertInterfaceIndexToLuid
- ConvertInterfaceLuidToAlias
- ConvertInterfaceLuidToGuid
- ConvertInterfaceLuidToIndex
- ConvertInterfaceLuidToNameA
- ConvertInterfaceLuidToNameW
- ConvertInterfaceNameToLuidA
- ConvertInterfaceNameToLuidW
- NET_LUID