deleteUnicastIpAddressEntry 函数 (netioapi.h)

项目
08/25/2023

DeleteUnicastIpAddressEntry 函数删除本地计算机上的现有单播 IP 地址条目。

语法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteUnicastIpAddressEntry(
  [in] const MIB_UNICASTIPADDRESS_ROW *Row
);

参数

[in] Row

指向要从本地计算机中删除的现有单播 IP 地址条目的MIB_UNICASTIPADDRESS_ROW 结构条目的指针。

返回值

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

如果函数失败，则返回值为以下错误代码之一。

返回代码	说明
ERROR_ACCESS_DENIED	访问被拒绝。此错误在以下几种情况下返回：用户在本地计算机上缺少所需的管理权限，或者应用程序未在增强的 shell 中运行，因为内置的管理员 (RunAs 管理员) 。
ERROR_INVALID_PARAMETER	向该函数传递了无效参数。如果在 Row 参数中传递 NULL 指针，Row 参数所指向MIB_UNICASTIPADDRESS_ROW的 Address 成员未设置为有效的单播 IPv4 或 IPv6 地址，或者未指定 Row 参数指向的MIB_UNICASTIPADDRESS_ROWInterfaceLuid 或 InterfaceIndex 成员，则返回此错误。
ERROR_NOT_FOUND	找不到指定的接口。如果找不到 Row 参数指向的MIB_UNICASTIPADDRESS_ROWInterfaceLuid 或 InterfaceIndex 成员指定的网络接口，则返回此错误。
ERROR_NOT_SUPPORTED	不支持该请求。如果本地计算机上没有 IPv4 堆栈，并且 Row 参数指向的 Address 成员MIB_UNICASTIPADDRESS_ROW指定了 IPv4 地址，则返回此错误。如果本地计算机上没有 IPv6 堆栈，并且地址成员中指定了 IPv6 地址，则也会返回此错误。
其他	使用 FormatMessage 获取返回错误的消息字符串。

注解

DeleteUnicastIpAddressEntry 函数在 Windows Vista 及更高版本上定义。

DeleteUnicastIpAddressEntry 函数用于删除本地计算机上的现有MIB_UNICASTIPADDRESS_ROW结构条目。

输入时，Row 参数指向MIB_UNICASTIPADDRESS_ROW结构中的 Address 成员必须设置为有效的单播 IPv4 或 IPv6 地址和系列。此外，必须初始化指向 Row 参数的 MIB_UNICASTIPADDRESS_ROW 结构中的至少一个成员：InterfaceLuid 或 InterfaceIndex。

字段按上面列出的顺序使用。因此，如果指定了 InterfaceLuid ，则使用此成员来确定接口。如果未为 InterfaceLuid 成员设置值 (此成员的值设置为零) ，则接下来使用 InterfaceIndex 成员来确定接口。

如果函数成功，则已删除 Row 参数表示的现有 IP 地址。

可以调用 GetUnicastIpAddressTable 函数来枚举本地计算机上的单播 IP 地址条目。可以调用 GetUnicastIpAddressEntry 函数来检索特定的现有单播 IP 地址条目。

DeleteUnicastIpAddressEntry 函数只能由以 Administrators 组成员身份登录的用户调用。如果 DeleteUnicastIpAddressEntry 由不是 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