DataCache.Put Method (String, Object, DataCacheItemVersion, Generic IEnumerable, String)

Article
08/26/2011

Adds or replaces an object in the specified region if it is at the specified version. Associates tags with the cached object.

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

returnValue = instance.Put(key, value, oldVersion, tags, region)

Syntax

'Declaration
Public Function Put ( _
    key As String, _
    value As Object, _
    oldVersion As DataCacheItemVersion, _
    tags As IEnumerable(Of DataCacheTag), _
    region As String _
) As DataCacheItemVersion

public DataCacheItemVersion Put (
    string key,
    Object value,
    DataCacheItemVersion oldVersion,
    IEnumerable<DataCacheTag> tags,
    string region
)

public:
DataCacheItemVersion^ Put (
    String^ key, 
    Object^ value, 
    DataCacheItemVersion^ oldVersion, 
    IEnumerable<DataCacheTag^>^ tags, 
    String^ region
)

public DataCacheItemVersion Put (
    String key, 
    Object value, 
    DataCacheItemVersion oldVersion, 
    IEnumerable<DataCacheTag> tags, 
    String region
)

public function Put (
    key : String, 
    value : Object, 
    oldVersion : DataCacheItemVersion, 
    tags : IEnumerable<DataCacheTag>, 
    region : String
) : DataCacheItemVersion

Parameters

key
The unique value that is used to identify the object in the region.

value
The object to add or replace.

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

tags
A list of tags to associate with the object.

region
The name of the region the object resides in.

Return Value

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

Remarks

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. For more information about concurrency, see Concurrency Models and Concurrency Methods.

This overload is useful for updating the tags associated with the object. For more information about methods available for using tags, see Tag-Based Methods.

For more information about using this method, see How to: Update an Object in 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