SetIpStatisticsEx 函数 (iphlpapi.h)
SetIpStatisticsEx 函数打开或关闭 IP 转发,并设置本地计算机的默认生存时间 (TTL) 值。
语法
IPHLPAPI_DLL_LINKAGE ULONG SetIpStatisticsEx(
[in] PMIB_IPSTATS Statistics,
ULONG Family
);
parameters
[in] Statistics
指向 MIB_IPSTATS 结构的指针。 调用方应将此结构的 dwForwarding 和 dwDefaultTTL 成员设置为新值。 若要使其中一个成员保持其当前值,请使用 MIB_USE_CURRENT_TTL 或 MIB_USE_CURRENT_FORWARDING。
Family
要为其设置转发和 TTL 的地址系列。
Winsock2.h 头文件中列出了地址系列的可能值。 请注意,AF_地址系列和PF_协议系列常量的值 (相同,例如 ,AF_INET 和 PF_INET) ,因此可以使用任一常量。
在针对 Windows Vista 及更高版本发布的 Windows SDK 上,头文件的组织方式已更改,并且 Ws2def.h 头文件中定义了此成员的可能值。 请注意, Ws2def.h 头文件会自动包含在 Winsock2.h 中,永远不应直接使用。
当前支持的值 AF_INET, AF_INET6。
值 | 含义 |
---|---|
|
Internet 协议版本 4 (IPv4) 地址系列。 指定此参数后,此函数将设置 IPv4 条目的转发和 TTL 选项。 |
|
Internet 协议版本 6 (IPv6) 地址系列。 指定此参数时,此函数将设置 IPv6 条目的转发和 TTL 选项。 |
返回值
如果函数成功,则返回值NO_ERROR。
如果函数失败,则返回值为以下错误代码之一。
返回代码 | 说明 |
---|---|
|
拒绝访问。 此错误在以下几种情况下返回:用户在本地计算机上缺少所需的管理权限,或者应用程序没有作为内置管理员 (RunAs 管理员) 在增强的 shell 中运行。 |
|
向该函数传递了无效参数。 如果在 pIpStats 参数中传递 NULL 指针,或者 Family 参数未设置为 AF_INET,则返回此错误,AF_INET6。 如果 pIpStats 参数指向的MIB_IPSTATS结构中的 dwForwarding 成员包含除 MIB_IP_NOT_FORWARDING、MIB_IP_FORWARDING 或 MIB_USE_CURRENT_FORWARDING 以外的值,也会返回此错误。 |
|
不支持该请求。 如果本地计算机上没有 IPv4 堆栈,并且已在 Family 参数中指定了AF_INET,或者本地计算机上没有 IPv6 堆栈,并且AF_INET6已在 Family 成员中指定,则返回此错误。 |
|
使用 FormatMessage 获取返回错误的消息字符串。 |
注解
若要仅设置默认 TTL,调用方也可以使用 SetIpTTL 函数。
SetIpStatisticsEx 函数只能由以管理员组成员身份登录的用户调用。 如果 SetIpStatisticsEx 由不是 Administrators 组成员的用户调用,则函数调用将失败并返回 ERROR_ACCESS_DENIED 。
SetIpStatisticsEx 函数也可能因为用户帐户控制 (Windows Vista 及更高版本上的 UAC) 而失败。 如果包含此函数的应用程序由以管理员组成员身份登录(而非内置管理员)的用户执行,则此调用将失败,除非应用程序已在清单文件中标记为 requestedExecutionLevel 设置为 requireAdministrator。 如果 上的应用程序缺少此清单文件,则以管理员组成员身份登录的用户(而不是内置管理员)必须在增强的 shell 中执行应用程序,因为内置管理员 (RunAs 管理员) ,此函数才能成功。
要求
最低受支持的客户端 | Windows Vista [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2003 [仅限桌面应用] |
目标平台 | Windows |
标头 | iphlpapi.h |
Library | Iphlpapi.lib |
DLL | Iphlpapi.dll |