GetAdapterIndex 函数 (iphlpapi.h)

GetAdapterIndex 函数获取适配器的索引(给定其名称)。

语法

IPHLPAPI_DLL_LINKAGE DWORD GetAdapterIndex(
  [in]      LPWSTR AdapterName,
  [in, out] PULONG IfIndex
);

参数

[in] AdapterName

指向 Unicode 字符串的指针,该字符串指定适配器的名称。

[in, out] IfIndex

指向指向适配器索引的 ULONG 变量的指针。

返回值

如果函数成功,则返回值NO_ERROR。

如果函数失败,请使用 FormatMessage 获取返回错误的消息字符串。

注解

在适配器完全禁用之前, GetAdapterIndex 函数将适配器报告为存在。 例如, NotifyAddrChange 函数可能指示删除了最近禁用的适配器的 IP 地址,但 GetAdapterIndex 会继续报告适配器索引,直到禁用适配器的过程完成。

当系统上存在一个或多个适配器时,当查询的适配器不存在时, GetAdapterIndex 将返回ERROR_DEV_NOT_EXIST。 如果没有适配器, GetAdapterIndex 函数将返回ERROR_NO_DATA。

适配器索引可能会在禁用然后启用适配器时发生更改,或者在其他情况下,不应被视为永久性。

要求

要求
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
目标平台 Windows
标头 iphlpapi.h
Library Iphlpapi.lib
DLL Iphlpapi.dll

另请参阅

GetAdaptersInfo

IP 帮助程序函数参考

IP 帮助程序起始页

IP_ADAPTER_INFO

MprConfigGetFriendlyName

MprConfigGetGuidName

NotifyAddrChange