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

 

Adds or replaces an object in the specified region if it is at the specified version. Specifies the timeout value and associates 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 Put(
	string key,
	object value,
	DataCacheItemVersion oldVersion,
	TimeSpan timeout,
	IEnumerable<DataCacheTag> tags,
	string region
)

Parameters

key
Type: System.String

The unique value that is used to identify the object in the region. Key names must be less than 65 KB.

value
Type: System.Object

The object to add or replace.

oldVersion
Type: Microsoft.ApplicationServer.Caching.DataCacheItemVersion

The DataCacheItemVersion object that represents the version of the cached object that is to be replaced.

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>

A list of tags to associate with the object.

region
Type: System.String

The name of the region the object resides in.

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.

By passing the oldVersion parameter, this method can maintain concurrency. If another process updates the cached object before this method is called, this method does not update the cached object and returns null.

This overload is useful for updating the tags associated with the object.

The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration.

Return to top
Show: