Share via

ConvertInterfaceNameToLuidW (NETIOAPI) (Compact 2013)

  • Article

3/26/2014

This function converts a Unicode network interface name to the locally unique identifier (LUID) for the interface.

Syntax

NETIOAPI_API
  ConvertInterfaceNameToLuidW(
    IN const WCHAR*  InterfaceName,
    OUT NET_LUID*  InterfaceLuid
    );

Parameters

  • InterfaceName
    A pointer to a NULL-terminated Unicode string that contains the network interface name.
  • InterfaceLuid
    A pointer to the NET_LUID structure for this interface.

Return Value

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

Error Code

Meaning

STATUS_INVALID_NAME

The interface name is invalid. ConvertInterfaceNameToLuidW returns this error if the InterfaceName parameter contains an invalid name or the length of the InterfaceName parameter exceeds the maximum allowed string length for this parameter.

STATUS_INVALID_PARAMETER

One of the parameters is invalid. ConvertInterfaceNameToLuidW returns this error if the InterfaceLuid parameter is NULL.

Remarks

The ConvertInterfaceNameToLuidW 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 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. The Ntddndis.h and Ifdef.h header files are automatically included in the Netioapi.h header file. You should not use the Ntddndis.h and Ifdef.h header files directly.

Use the ConvertInterfaceNameToLuidA (NETIOAPI) function to convert an ANSI interface name to a LUID.

See Also

Reference

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