Export (0) Print
Expand All

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

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)

'Declaration
Public Overridable Function Add ( _
	key As String, _
	value As Object, _
	absoluteExpiration As DateTimeOffset, _
	regionName As String _
) As Boolean

Parameters

key
Type: System.String

A unique identifier for the cache entry.

value
Type: System.Object

The object to insert.

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

regionName
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 Nothing.

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

Supported in: 4.5, 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft