DataCache.Add Method (String, Object, Generic IEnumerable)

Article
08/26/2011

Adds an object to the cache. This method enables associating tags with the cached object.

Namespace: Microsoft.ApplicationServer.Caching
Assembly: Microsoft.ApplicationServer.Caching.Client (in microsoft.applicationserver.caching.client.dll)

Usage

'Usage
Dim instance As DataCache
Dim key As String
Dim value As Object
Dim tags As IEnumerable(Of DataCacheTag)
Dim returnValue As DataCacheItemVersion

returnValue = instance.Add(key, value, tags)

Syntax

'Declaration
Public Function Add ( _
    key As String, _
    value As Object, _
    tags As IEnumerable(Of DataCacheTag) _
) As DataCacheItemVersion

public DataCacheItemVersion Add (
    string key,
    Object value,
    IEnumerable<DataCacheTag> tags
)

public:
DataCacheItemVersion^ Add (
    String^ key, 
    Object^ value, 
    IEnumerable<DataCacheTag^>^ tags
)

public DataCacheItemVersion Add (
    String key, 
    Object value, 
    IEnumerable<DataCacheTag> tags
)

public function Add (
    key : String, 
    value : Object, 
    tags : IEnumerable<DataCacheTag>
) : DataCacheItemVersion

Parameters

key
A unique value that is used to store and retrieve the object from the cache.

value
The object saved to the cache cluster.

tags
An array of DataCacheTag objects to associate with the cached object.

Return Value

A DataCacheItemVersion object that represents the version of the object saved to the cache under the key value.

Remarks

If an item using the same key is already present in the cache, this call throws an exception of type DataCacheException with the ErrorCode set to KeyAlreadyExists. Expiration settings are derived from the named cache configuration.

Tags may only be used to retrieve a cached object if that object is stored in a region. This overload does not save the object to a region.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Visual Studio 2010 and later, .NET Framework 4

Target Platforms

Windows 7; Windows Server 2008 R2; Windows Server 2008 Service Pack 2; Windows Vista Service Pack 2