ConvertInterfaceLuidToAlias 函数

项目
06/15/2023

ConvertInterfaceLuidToAlias 函数将网络接口的本地唯一标识符 (LUID) 转换为接口别名。

注意

ConvertInterfaceXxx API 系列枚举绑定到 TCP/IP 的所有接口上的标识符，其中可能包括虚拟微型端口、轻型筛选器、隧道适配器和物理接口。

语法

NETIOAPI_API ConvertInterfaceLuidToAlias(
  _In_  const NET_LUID *InterfaceLuid,
  _Out_       PWSTR    InterfaceAlias,
  _In_        SIZE_T   Length
);

参数

InterfaceLuid [in]
指向网络接口 NET_LUID 联合的指针。
InterfaceAlias [out]
指向缓冲区的指针，用于保存以 NULL 结尾的 Unicode 字符串。如果 ConvertInterfaceLuidToAlias 成功返回， 则 InterfaceAlias 包含网络接口的别名。
长度 [in]
InterfaceAlias 参数指向的缓冲区的长度（按字符计数）。此值必须足够大，才能保存网络接口的别名和终止 NULL 字符。允许的最大长度为 NDIS_IF_MAX_STRING_SIZE + 1。有关NDIS_IF_MAX_STRING_SIZE的详细信息，请参阅以下“备注”部分。

返回值

如果函数成功，ConvertInterfaceLuidToAlias 将返回STATUS_SUCCESS。如果函数失败， ConvertInterfaceLuidToAlias 将返回以下错误代码之一：

返回代码	说明
STATUS_INVALID_PARAMETER	其中一个参数无效。如果 InterfaceLuid 或 InterfaceAlias 为 NULL，或者 InterfaceLuid 无效，ConvertInterfaceLuidToAlias 将返回此错误。
STATUS_NOT_ENOUGH_MEMORY	没有足够的存储空间可用。如果 InterfaceAlias 参数指向的缓冲区的大小不如 Length 参数中指定的大小，因此缓冲区无法保存别名，则 ConvertInterfaceLuidToAlias 将返回此错误。

注解

ConvertInterfaceLuidToAlias 函数与协议无关，适用于 IPv6 和 IPv4 协议的网络接口。

在 Ntddndis.h 头文件中声明网络接口别名的最大长度（NDIS_IF_MAX_STRING_SIZE，不含终止 NULL 字符）。 NDIS_IF_MAX_STRING_SIZE定义为在 Ifdef.h 头文件中定义的IF_MAX_STRING_SIZE常量。

注意

Ntddndis.h 和 Ifdef.h 头文件将自动包含在 Netioapi.h 头文件中。切勿直接使用 Ntddndis.h 和 Ifdef.h 头文件。

要求

目标平台	通用
版本	在 Windows Vista 和更高版本的 Windows 操作系统中可用。
标头	Netioapi.h (包括 Netioapi.h)
库	Netio.lib
IRQL	PASSIVE_LEVEL