ObjectCache.Add Method (String, Object, DateTimeOffset, String)

.NET Framework (current version)

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

When overridden in a derived class, inserts a cache entry into the cache without overwriting any existing cache entry.

Namespace:   System.Runtime.Caching
Assembly:  System.Runtime.Caching (in System.Runtime.Caching.dll)

public virtual bool Add(
	string key,
	object value,
	DateTimeOffset absoluteExpiration,
	string regionName = null


Type: System.String

A unique identifier for the cache entry.

Type: System.Object

The object to insert.

Type: System.DateTimeOffset

The fixed date and time at which the cache entry will expire. This parameter is required when the Add method is called.

Type: System.String

Optional. A named region in the cache to which the cache entry can be added, if regions are implemented. Because regions are not implemented in .NET Framework 4, the default value is null.

Return Value

Type: System.Boolean

true if insertion succeeded, or false if there is an already an entry in the cache that has the same key as key.

The Add method overloads are virtual (not abstract) on the ObjectCache class, because the Add method internally calls AddOrGetExisting. This reduces the number of method overloads that a cache implementer has to provide. If a cache implementation does not require any special behavior for the Add method, it can just implement the AddOrGetExisting method overloads.

.NET Framework
Available since 4.0
Return to top