This documentation is archived and is not being maintained.

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

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
)

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

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

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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: