DataCache.PutAndUnlock Method (String, Object, DataCacheLockHandle, TimeSpan, IEnumerable<DataCacheTag>)

Replaces and unlocks an object in the cache. 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 PutAndUnlock(
    string key,
    object value,
    DataCacheLockHandle lockHandle,
    TimeSpan timeout,
    IEnumerable<DataCacheTag> tags
)

public:
DataCacheItemVersion^ PutAndUnlock(
    String^ key,
    Object^ value,
    DataCacheLockHandle^ lockHandle,
    TimeSpan timeout,
    IEnumerable<DataCacheTag^>^ tags
)

member PutAndUnlock : 
        key:string *
        value:Object *
        lockHandle:DataCacheLockHandle *
        timeout:TimeSpan *
        tags:IEnumerable<DataCacheTag> -> DataCacheItemVersion

Public Function PutAndUnlock (
    key As String,
    value As Object,
    lockHandle As DataCacheLockHandle,
    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.

• value
  Type: System.Object

  The object to add or replace.

• lockHandle
  Type: Microsoft.ApplicationServer.Caching.DataCacheLockHandle

  The DataCacheLockHandle object that was returned when the object was locked.

• 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 cached object after it has been updated by this method.

Remarks

Locked objects are never expired, but they may expire immediately if unlocked after their expiration time.

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.

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

If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, a DataCacheException object is thrown with the ErrorCode property set to InvalidCacheLockHandle, and the object is not updated.

See Also

PutAndUnlock Overload
DataCache Class
Microsoft.ApplicationServer.Caching Namespace

Return to top