deleteIpNetEntry2 函数 (netioapi.h)
DeleteIpNetEntry2 函数删除本地计算机上的相邻 IP 地址条目。
语法
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteIpNetEntry2(
[in] const MIB_IPNET_ROW2 *Row
);
参数
[in] Row
指向邻居 IP 地址条目 MIB_IPNET_ROW2 结构条目的指针。 成功返回后,将删除此条目。
返回值
如果函数成功,则返回值NO_ERROR。
如果函数失败,则返回值为以下错误代码之一。
返回代码 | 说明 |
---|---|
|
访问被拒绝。 此错误在以下几种情况下返回:用户在本地计算机上缺少所需的管理权限,或者应用程序没有作为内置管理员 (RunAs 管理员) 在增强的 shell 中运行。 |
|
向该函数传递了无效参数。 如果在 Row 参数中传递 NULL 指针,Row 参数指向MIB_IPNET_ROW2的 Address 成员未设置为有效的邻居 IPv4 或 IPv6 地址,或者未指定 Row 参数指向的MIB_IPNET_ROW2的 InterfaceLuid 或 InterfaceIndex 成员,则返回此错误。 |
|
找不到指定的接口。 如果找不到 Row 参数指向的MIB_IPNET_ROW2的 InterfaceLuid 或 InterfaceIndex 成员指定的网络接口,则返回此错误。 |
|
不支持该请求。 如果本地计算机上没有 IPv4 堆栈,并且已在 Row 参数指向的MIB_IPNET_ROW2的 Address 成员中指定了 IPv4 地址,则返回此错误。 如果本地计算机上没有 IPv6 堆栈,并且 地址成员中 指定了 IPv6 地址,则也会返回此错误。 |
|
使用 FormatMessage 获取返回错误的消息字符串。 |
注解
DeleteIpNetEntry2 函数在 Windows Vista 及更高版本上定义。
DeleteIpNetEntry2 函数用于删除MIB_IPNET_ROW2结构条目。
输入时,Row 参数指向的 MIB_IPNET_ROW2 结构中的 Address 成员必须初始化为有效的邻居 IPv4 或 IPv6 地址和系列。 此外,必须初始化指向 Row 参数的 MIB_IPNET_ROW2 结构中的以下至少一个成员:InterfaceLuid 或 InterfaceIndex。
字段按上面列出的顺序使用。 因此,如果指定 了 InterfaceLuid ,则使用此成员来确定接口。 如果没有为 InterfaceLuid 成员设置值, (此成员的值) 设置为零,则接下来使用 InterfaceIndex 成员来确定接口。
在调用成功时输出时, DeleteIpNetEntry2 会删除邻居 IP 地址。
可以调用 GetIpNetTable2 函数来枚举本地计算机上的相邻 IP 地址条目。
DeleteIpNetEntry2 函数只能由以管理员组成员身份登录的用户调用。 如果 DeleteIpNetEntry2 由不是 Administrators 组成员的用户调用,则函数调用将失败并返回 ERROR_ACCESS_DENIED 。 此函数也可能因为 Windows Vista 及更高版本上的用户帐户控制 (UAC) 而失败。 如果包含此函数的应用程序由以管理员组成员身份登录(而非内置管理员)的用户执行,则此调用将失败,除非应用程序已在清单文件中标记为 requestedExecutionLevel 设置为 requireAdministrator。 如果应用程序缺少此清单文件,则作为管理员组成员(而非内置管理员)登录的用户必须在增强的 shell 中执行应用程序,因为内置管理员 (RunAs 管理员) 才能使此功能成功。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2008 [仅限桌面应用] |
目标平台 | Windows |
标头 | netioapi.h (包括 Iphlpapi.h) |
Library | Iphlpapi.lib |
DLL | Iphlpapi.dll |