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

 

Adds or replaces an object in the specified region if it is at the specified version. 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,
    IEnumerable<DataCacheTag> tags,
    string region
)

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

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

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

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.

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

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.

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

See Also

Put Overload
DataCache Class
Microsoft.ApplicationServer.Caching Namespace

Return to top