SetIpStatistics

The SetIpStatistics function toggles IP forwarding on or off and sets the default time-to-live (TTL) value for the local computer.

DWORD SetIpStatistics(
PMIB_IPSTATS pIpStats // new forwarding and TTL settings);

Parameters

  • pIpStats
    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.

Return Values

If the function succeeds, the return value is NO_ERROR.

If the function fails, 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.

Requirements

Runs On Versions Defined in Include Link to
Windows CE OS 3.0 and later Iphlpapi.h   Iphlpapi.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

FormatMessage, MIB_IPSTATS, SetIpTTL

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.