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

.NET Framework (current version)
 
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.

When overridden in a derived class, inserts a cache entry into the cache, specifying information about how the entry will be evicted.

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

public virtual bool Add(
	string key,
	object value,
	CacheItemPolicy policy,
	string regionName = null
)

Parameters

key
Type: System.String

A unique identifier for the cache entry.

value
Type: System.Object

The object to insert.

policy
Type: System.Runtime.Caching.CacheItemPolicy

An object that contains eviction details for the cache entry. This object provides more options for eviction than a simple absolute expiration.

regionName
Type: System.String

Optional. A named region in the cache to which the cache entry can be added, if regions are implemented. The default value for the optional parameter is null.

Return Value

Type: System.Boolean

true if the insertion try succeeds, or false if there is an already an entry in the cache with 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
Show: