DataCache.PutAndUnlock Method (String, Object, DataCacheLockHandle, Generic IEnumerable, String)

Article
08/26/2011

Replaces and unlocks an object in the specified region. Associates tags with the cached object.

Namespace: Microsoft.ApplicationServer.Caching
Assembly: Microsoft.ApplicationServer.Caching.Client (in microsoft.applicationserver.caching.client.dll)

Usage

'Usage
Dim instance As DataCache
Dim key As String
Dim value As Object
Dim lockHandle As DataCacheLockHandle
Dim tags As IEnumerable(Of DataCacheTag)
Dim region As String
Dim returnValue As DataCacheItemVersion

returnValue = instance.PutAndUnlock(key, value, lockHandle, tags, region)

Syntax

'Declaration
Public Function PutAndUnlock ( _
    key As String, _
    value As Object, _
    lockHandle As DataCacheLockHandle, _
    tags As IEnumerable(Of DataCacheTag), _
    region As String _
) As DataCacheItemVersion

public DataCacheItemVersion PutAndUnlock (
    string key,
    Object value,
    DataCacheLockHandle lockHandle,
    IEnumerable<DataCacheTag> tags,
    string region
)

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

public DataCacheItemVersion PutAndUnlock (
    String key, 
    Object value, 
    DataCacheLockHandle lockHandle, 
    IEnumerable<DataCacheTag> tags, 
    String region
)

public function PutAndUnlock (
    key : String, 
    value : Object, 
    lockHandle : DataCacheLockHandle, 
    tags : IEnumerable<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.

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

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 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. For more information, see Expiration and Eviction.

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.

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Visual Studio 2010 and later, .NET Framework 4

Target Platforms

Windows 7; Windows Server 2008 R2; Windows Server 2008 Service Pack 2; Windows Vista Service Pack 2