SALES: 1-800-867-1380

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

 

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. 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,
	TimeSpan timeout,
	IEnumerable<DataCacheTag> tags,
	string region
)

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.

timeout
Type: System.TimeSpan

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

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

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

region
Type: System.String

The name of the region to save the 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. The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2016 Microsoft