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

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

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

Namespace: Microsoft.Data.Caching
Assembly: ClientLibrary (in clientlibrary.dll)

Syntax

'Declaration
Public Function Put ( _
    key As String, _
    value As Object, _
    oldVersion As DataCacheItemVersion, _
    tags As List(Of DataCacheTag), _
    region As String _
) As DataCacheItemVersion
'Usage
Dim instance As DataCache
Dim key As String
Dim value As Object
Dim oldVersion As DataCacheItemVersion
Dim tags As List(Of DataCacheTag)
Dim region As String
Dim returnValue As DataCacheItemVersion

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

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

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

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

public function Put (
    key : String, 
    value : Object, 
    oldVersion : DataCacheItemVersion, 
    tags : List<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 (Velocity) and Concurrency Methods (Velocity).

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 (Velocity).

For more information about using this method, see How to: Update an Object in Cache (Velocity).

See Also

Reference

DataCache Class
DataCache Members
Microsoft.Data.Caching Namespace