DataCache.PutAndUnlock Method (String, Object, DataCacheLockHandle, TimeSpan, Generic List, String)
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Replaces and unlocks an object in the specified region. Specifies the timeout value and associates tags with the cached object.
Namespace: Microsoft.Data.Caching
Assembly: ClientLibrary (in clientlibrary.dll)
Syntax
'Declaration
Public Function PutAndUnlock ( _
key As String, _
value As Object, _
lockHandle As DataCacheLockHandle, _
timeout As TimeSpan, _
tags As List(Of DataCacheTag), _
region As String _
) As DataCacheItemVersion
'Usage
Dim instance As DataCache
Dim key As String
Dim value As Object
Dim lockHandle As DataCacheLockHandle
Dim timeout As TimeSpan
Dim tags As List(Of DataCacheTag)
Dim region As String
Dim returnValue As DataCacheItemVersion
returnValue = instance.PutAndUnlock(key, value, lockHandle, timeout, tags, region)
public DataCacheItemVersion PutAndUnlock (
string key,
Object value,
DataCacheLockHandle lockHandle,
TimeSpan timeout,
List<DataCacheTag> tags,
string region
)
public:
DataCacheItemVersion^ PutAndUnlock (
String^ key,
Object^ value,
DataCacheLockHandle^ lockHandle,
TimeSpan timeout,
List<DataCacheTag^>^ tags,
String^ region
)
public DataCacheItemVersion PutAndUnlock (
String key,
Object value,
DataCacheLockHandle lockHandle,
TimeSpan timeout,
List<DataCacheTag> tags,
String region
)
public function PutAndUnlock (
key : String,
value : Object,
lockHandle : DataCacheLockHandle,
timeout : TimeSpan,
tags : List<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.
- 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.
- 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. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated.
Remarks
Locked objects are never expired, but they may expire immediately if unlocked after their expiration time. For more information, see Expiration and Eviction (Velocity).
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 (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).
See Also
Reference
DataCache Class
DataCache Members
Microsoft.Data.Caching Namespace