HttpCachePolicy.SetMaxAge Method (TimeSpan)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Sets the Cache-Control: max-age HTTP header based on the specified time span.

Namespace:   System.Web
Assembly:  System.Web (in System.Web.dll)

public void SetMaxAge(
	TimeSpan delta
)

Parameters

delta
Type: System.TimeSpan

The time span used to set the Cache - Control: max-age header.

Exception Condition
ArgumentOutOfRangeException

delta is less than 0 or greater than one year.

Max-age is the maximum absolute time a document is allowed to exist before being considered stale.

The SetMaxAge method does not use sliding expiration and will fail if the expiration date violates the principle of restrictiveness.

SetMaxAge is introduced in the .NET Framework version 3.5. For more information, see .NET Framework Versions and Dependencies.

System_CAPS_noteNote

If the SetMaxAge method is called repeatedly, on the second and subsequent calls, the value of the maximum age can only be decreased.

The following code example demonstrates how to set the Cache-Control: max-age header to 0 hours, 30 minutes, and 0 seconds.

TimeSpan ts = new TimeSpan(0,30,0);
 Response.Cache.SetMaxAge(ts);

.NET Framework
Available since 1.1
Return to top
Show: