SetIpStatisticsEx function (iphlpapi.h)
The SetIpStatisticsEx function toggles IP forwarding on or off and sets the default time-to-live (TTL) value for the local computer.
Syntax
IPHLPAPI_DLL_LINKAGE ULONG SetIpStatisticsEx(
[in] PMIB_IPSTATS Statistics,
ULONG Family
);
Parameters
[in] Statistics
A pointer to a MIB_IPSTATS structure. The caller should set the dwForwarding and dwDefaultTTL members of this structure to the new values. To keep one of the members at its current value, use MIB_USE_CURRENT_TTL or MIB_USE_CURRENT_FORWARDING.
Family
The address family for which forwarding and TTL is to be set.
Possible values for the address family are listed in the Winsock2.h header file. Note that the values for the AF_ address family and PF_ protocol family constants are identical (for example, AF_INET and PF_INET), so either constant can be used.
On the Windows SDK released for Windows Vista and later, the organization of header files has changed and possible values for this member are defined in the Ws2def.h header file. Note that the Ws2def.h header file is automatically included in Winsock2.h, and should never be used directly.
The values currently supported are AF_INET, and AF_INET6.
Return value
If the function succeeds, the return value is NO_ERROR.
If the function fails, the return value is one of the following error codes.
| Return code | Description |
|---|---|
|
Access is denied. This error is returned under several conditions that include the following: the user lacks the required administrative privileges on the local computer or the application is not running in an enhanced shell as the built-in Administrator (RunAs administrator). |
|
An invalid parameter was passed to the function. This error is returned if a NULL pointer is passed in the pIpStats parameter or the Family parameter was not set to AF_INET, and AF_INET6. This error is also returned if the dwForwarding member in the MIB_IPSTATS structure pointed to by the pIpStats parameter contains a value other than MIB_IP_NOT_FORWARDING, MIB_IP_FORWARDING, or MIB_USE_CURRENT_FORWARDING. |
|
The request is not supported. This error is returned if no IPv4 stack is on the local computer and AF_INET was specified in the Family parameter or no IPv6 stack is on the local computer and AF_INET6 was specified in the Family member. |
|
Use FormatMessage to obtain the message string for the returned error. |
Remarks
To set only the default TTL, the caller can also use the SetIpTTL function.
The SetIpStatisticsEx function can only be called by a user logged on as a member of the Administrators group. If SetIpStatisticsEx is called by a user that is not a member of the Administrators group, the function call will fail and ERROR_ACCESS_DENIED is returned.
The SetIpStatisticsEx function can also fail because of user account control (UAC) on Windows Vista and later. If an application that contains this function is executed by a user logged on as a member of the Administrators group other than the built-in Administrator, this call will fail unless the application has been marked in the manifest file with a requestedExecutionLevel set to requireAdministrator. If the application on lacks this manifest file, a user logged on as a member of the Administrators group other than the built-in Administrator must then be executing the application in an enhanced shell as the built-in Administrator (RunAs administrator) for this function to succeed.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | iphlpapi.h |
| Library | Iphlpapi.lib |
| DLL | Iphlpapi.dll |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for