PutAndUnlock Method (String, Object, DataCacheLockHandle, TimeSpan)

Replaces and unlocks an object in the cache. Specifies the timeout value of the cached object.

Namespace:  Microsoft.ApplicationServer.Caching
Assembly:  Microsoft.ApplicationServer.Caching.Client (in Microsoft.ApplicationServer.Caching.Client.dll)

public DataCacheItemVersion PutAndUnlock(
	string key,
	Object value,
	DataCacheLockHandle lockHandle,
	TimeSpan timeout
)

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.

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.

Locked objects are never expired, but they may expire immediately if unlocked after their expiration time. For more information, see <maml:externalLink><maml:linkText>Expiration and Eviction</maml:linkText><maml:linkUri>http://go.microsoft.com/fwlink/?LinkID=193435</maml:linkUri></maml:externalLink>.

The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration. For more information, see <maml:externalLink><maml:linkText>Expiration and Eviction</maml:linkText><maml:linkUri>http://go.microsoft.com/fwlink/?LinkID=193435</maml:linkUri></maml:externalLink>.

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.

Show: