convertInterfaceNameToLuidA 函数 (netioapi.h)

项目
03/05/2024

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

语法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceNameToLuidA(
  [in]  const CHAR *InterfaceName,
  [out] NET_LUID   *InterfaceLuid
);

参数

[in] InterfaceName

指向包含网络接口名称的 以 NULL 结尾的 ANSI 字符串的指针。

[out] InterfaceLuid

指向此接口 NET_LUID 的指针。

返回值

成功后， ConvertInterfaceNameToLuidA 返回 NETIO_ERROR_SUCCESS。任何非零返回值都表示失败。

错误代码	含义
ERROR_BUFFER_OVERFLOW	ANSI 接口名称的长度无效。如果 InterfaceName 参数超出了此参数允许的最大字符串长度，则返回此错误。
ERROR_INVALID_NAME	接口名称无效。如果 InterfaceName 参数包含无效的名称，则返回此错误。
ERROR_INVALID_PARAMETER	某个参数无效。如果 InterfaceLuid 参数为 NULL，则返回此错误。

注解

ConvertInterfaceNameToLuidA 函数在 Windows Vista 及更高版本上可用。

ConvertInterfaceNameToLuidA 函数独立于协议，适用于 IPv6 和 IPv4 协议的网络接口。 ConvertInterfaceNameToLuidA 将 ANSI 接口名称转换为 LUID。

ConvertInterfaceNameToLuidW 将 Unicode 接口名称转换为 LUID。

在 Ntddndis.h 头文件中声明没有终止 NULL 的接口名称的最大长度NDIS_IF_MAX_STRING_SIZE。 NDIS_IF_MAX_STRING_SIZE定义为 Ifdef.h 头文件中定义的IF_MAX_STRING_SIZE常量。 Ntddndis.h 和 Ifdef.h 头文件自动包含在 Iphlpapi.h 头文件自动包含的 Netioapi.h 头文件中。永远不应直接使用 Ntddndis.h、 Ifdef.h 和 Netioapi.h 头文件。

要求

要求	值
最低受支持的客户端	Windows Vista [仅限桌面应用]
最低受支持的服务器	Windows Server 2008 [仅限桌面应用]
目标平台	Windows
标头	netioapi.h (包括 Iphlpapi.h)
Library	Iphlpapi.lib
DLL	Iphlpapi.dll