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

 

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

Syntax

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

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

member Put : 
        key:string *
        value:Object *
        oldVersion:DataCacheItemVersion *
        timeout:TimeSpan *
        tags:IEnumerable<DataCacheTag> -> DataCacheItemVersion

Public Function Put (
    key As String,
    value As Object,
    oldVersion As DataCacheItemVersion,
    timeout As TimeSpan,
    tags As IEnumerable(Of DataCacheTag)
) As DataCacheItemVersion

Parameters

• key
  Type: System.String

  The unique value that is used to identify the object in the cache. 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.

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.

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.

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

See Also

Put Overload
DataCache Class
Microsoft.ApplicationServer.Caching Namespace

Return to top