Get the cache item stored in cache.
Namespace: Alachisoft.NCache.Web.CachingAssembly: Alachisoft.NCache.Web (in Alachisoft.NCache.Web.dll) Version: 4.1.0.0 (4.1.0.0)
Syntax
C# |
---|
public override CacheItem GetCacheItem( string key, TimeSpan lockTimeout, ref LockHandle lockHandle, bool acquireLock ) |
Visual Basic |
---|
Public Overrides Function GetCacheItem ( _ key As String, _ lockTimeout As TimeSpan, _ ByRef lockHandle As LockHandle, _ acquireLock As Boolean _ ) As CacheItem |
Visual C++ |
---|
public: virtual CacheItem^ GetCacheItem( String^ key, TimeSpan lockTimeout, LockHandle^% lockHandle, bool acquireLock ) override |
Parameters
- key
- Type: System..::..String
Key used to reference the desired object
- lockTimeout
- Type: System..::..TimeSpan
The TimeSpan after which the lock is automatically released.
- lockHandle
- Type: Alachisoft.NCache.Web.Caching..::..LockHandle%
An instance of LockHandle to hold the lock information.
- acquireLock
- Type: System..::..Boolean
A flag to determine whether to acquire a lock or not.
Return Value
The retrieved cache item, or a null reference (Nothing in Visual Basic) if the key is not found.Remarks
Note: If exceptions are enabled through the ExceptionsEnabled setting, this property throws exception incase of failure.