Edit

HttpCachePolicy.SetMaxAge(TimeSpan) Method

  • Reference

Definition

Namespace:
System.Web
Assembly:
System.Web.dll

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

public:
 void SetMaxAge(TimeSpan delta);
public void SetMaxAge (TimeSpan delta);
member this.SetMaxAge : TimeSpan -> unit
Public Sub SetMaxAge (delta As TimeSpan)

Parameters

delta
TimeSpan

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

Exceptions

ArgumentOutOfRangeException

delta is less than 0 or greater than one year.

Examples

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);

Dim ts As New TimeSpan(0,30,0)
 Response.Cache.SetMaxAge(ts)

Remarks

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 Versions and Dependencies.

Note

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

Applies to