Platform SDK: Internet Protocol Helper

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

  Windows NT/2000: Requires Windows NT 4.0 SP4 or later.
  Windows 95/98: Requires Windows 98.
  Header: Declared in Iphlpapi.h.
  Library: Use Iphlpapi.lib.

See Also

MIB_IPSTATS, SetIpTTL