SALES: 1-800-867-1380

Add Method (String, Object, TimeSpan, IEnumerable(DataCacheTag))

Adds an object to 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
)

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<(Of <(<'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. The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration. Expiration settings are derived from the named cache configuration.

Important noteImportant

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft