This documentation is archived and is not being maintained.

HttpCachePolicy::SetMaxAge Method

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.

ExceptionCondition
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.

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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: