Retrieves the specified item from the Cache object. If the object is read through the data source, put it in the cache. It accepts the CacheItemVersion by reference. If null is passed for CacheItemVersion, then the version of the object from the cache is returned. If non-null CacheItemVersion is passed, then object is returned from the cache only if that is the current version of the object in the cache.

Namespace: Alachisoft.NCache.Web.Caching
Assembly: Alachisoft.NCache.Web (in Alachisoft.NCache.Web.dll) Version: (


public virtual CacheItem GetCacheItem(
	string key,
	DSReadOption dsReadOption,
	ref CacheItemVersion version
Visual Basic
Public Overridable Function GetCacheItem ( 
	key As String,
	dsReadOption As DSReadOption,
	ByRef version As CacheItemVersion
) As CacheItem
Visual C++
virtual CacheItem^ GetCacheItem(
	String^ key, 
	DSReadOption dsReadOption, 
	CacheItemVersion^% version


Type: System..::..String
The identifier for the cache item to retrieve.
Type: Alachisoft.NCache.Web.Caching..::..DSReadOption
Options regarding reading from data source.
Type: Alachisoft.NCache.Web.Caching..::..CacheItemVersion%
The version of the object.

Return Value

Type: CacheItem
The retrieved cache item, or a null reference (Nothing in Visual Basic) if the key is not found.


Note: If exceptions are enabled through the ExceptionsEnabled setting, this property throws exception incase of failure.


The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control. The version of the cached object is also received.
 Copy imageCopy
Cache cache = NCache.InitializeCache("myCache");
CacheItemVersion version = null;
string textBoxValue = (string) cache.Get("MyTextBox.Value", DSReadOption.ReadThru, ref version);


System..::..ArgumentNullExceptionkey contains a null reference (Nothing in Visual Basic).

See Also