ConvertInterfaceAliasToLuid (NETIOAPI) (Compact 2013)

  • Article

3/26/2014

This 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
    A pointer to a NULL-terminated Unicode string that contains the alias name of the network interface.
  • InterfaceLuid
    A pointer to the NET_LUID structure 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:

Error Code

Meaning

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.

Remarks

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

See Also

Reference

IP Helper Kernel-Mode Functions
ConvertInterfaceGuidToLuid (NETIOAPI)
ConvertInterfaceIndexToLuid (NETIOAPI)
ConvertInterfaceLuidToGuid (NETIOAPI)
ConvertInterfaceLuidToIndex (NETIOAPI)
ConvertInterfaceLuidToNameA (NETIOAPI)
ConvertInterfaceLuidToNameW (NETIOAPI)
ConvertInterfaceNameToLuidA (NETIOAPI)
ConvertInterfaceNameToLuidW (NETIOAPI)
NET_LUID