GetAndLock Method (String, TimeSpan, DataCacheLockHandle, Boolean)

Lock the key if key is present and it is not locked by any clients and returns the object corresponding to the key.

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

public Object GetAndLock(
	string key,
	TimeSpan timeout,
	out DataCacheLockHandle lockHandle,
	bool forceLock
)

Parameters

key
Type: System..::..String
The unique value that is used to identify the object in the region.
timeout
Type: System..::..TimeSpan
The amount of time that object remains locked.
lockHandle
Type: Microsoft.ApplicationServer.Caching..::..DataCacheLockHandle%
The DataCacheLockHandle object required to unlock the object. The lockHandle output parameter is passed by reference.
forceLock
Type: System..::..Boolean
If forceLock is true, key is locked irrespective of key-value pair presence in cache.

Return Value

Type: System..::..Object
Returns Object matching the specified key parameter if the Object is present and is not locked.
  • If the key does not exist, a DataCacheException object is thrown with the ErrorCode set to KeyDoesNotExist. Create objects based on the referenced key to resolve this error.

  • If the object is already locked by another cache client, a DataCacheException object is thrown with the ErrorCode set to ObjectLocked. The object will be inaccessible until it is unlocked by the locking client.

Show: