DataCache.Add Method (String, Object, IEnumerable<DataCacheTag>)

 

Adds an object to the cache. This method enables associating tags with the cached object. This overload is not supported in Windows Azure Shared Caching.

Namespace:   Microsoft.ApplicationServer.Caching
Assembly:  Microsoft.ApplicationServer.Caching.Client (in Microsoft.ApplicationServer.Caching.Client.dll)

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

Parameters

key
Type: System.String

A unique value that is used to store and retrieve the object from the cache. Key names must be less than 65 KB.

value
Type: System.Object

The object saved to the cache.

tags
Type: System.Collections.Generic.IEnumerable<DataCacheTag>

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

Return Value

Type: Microsoft.ApplicationServer.Caching.DataCacheItemVersion

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

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.

Return to top
Show: