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

Article
08/26/2011

Adds an object to a region in the cache. This method enables associating tags with the cached object and specifying when the object should be expired.

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 timeout As TimeSpan
Dim tags As IEnumerable(Of DataCacheTag)
Dim region As String
Dim returnValue As DataCacheItemVersion

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

Syntax

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

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

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

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

public function Add (
    key : String, 
    value : Object, 
    timeout : TimeSpan, 
    tags : IEnumerable<DataCacheTag>, 
    region : String
) : 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.

timeout
The amount of time that the object should reside in the cache before expiration.

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

region
The name of the region to save the 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.

The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration. For more information, see Expiration and Eviction. For more information about how to use this method, see How to: Add an Object to Cache.

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

Share via