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

[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 cache if it is at the specified version. Specifies the timeout value and 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, _
    timeout As TimeSpan, _
    tags As List(Of DataCacheTag) _
) As DataCacheItemVersion
'Usage
Dim instance As DataCache
Dim key As String
Dim value As Object
Dim oldVersion As DataCacheItemVersion
Dim timeout As TimeSpan
Dim tags As List(Of DataCacheTag)
Dim returnValue As DataCacheItemVersion

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

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

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

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

public function Put (
    key : String, 
    value : Object, 
    oldVersion : DataCacheItemVersion, 
    timeout : TimeSpan, 
    tags : List<DataCacheTag>
) : DataCacheItemVersion

Parameters

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

• value
  The object to add or replace.

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

• timeout
  A non-zero value that is used to specify how many minutes the object should reside in the cache before expiration.

• tags
  A list of tags to associate with the object.

Return Value

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

Remarks

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.

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

The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration. For more information, see Expiration and Eviction (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