Retrieves the specified item from the Cache object. If the object is read thru the data source, put is against the given group and sub group.

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

Syntax

C#
public override Object Get(
	string key,
	DSReadOption dsReadOption,
	ref CacheItemVersion version
)
Visual Basic
Public Overrides Function Get ( 
	key As String,
	dsReadOption As DSReadOption,
	ByRef version As CacheItemVersion
) As Object
Visual C++
public:
virtual Object^ Get(
	String^ key, 
	DSReadOption dsReadOption, 
	CacheItemVersion^% version
) override

Parameters

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

Return Value

Type: Object
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.

Note: The group and subGroup parameters are used only if the object is read thru the data source. Otherwise the object will be returned from the cache whether it belongs to the given group and sub group or not.

Examples

The following example demonstrates how to retrieve the value cached for an ASP.NET text box server control.
 Copy imageCopy
NCache.Cache.Get("MyTextBox.Value", "Customer", null);
Or simply in a class deriving from [!:Alachisoft.NCache.Web.UI.NPage] or [!:Alachisoft.NCache.Web.UI.NUserControl].
 Copy imageCopy
Cache.Get("MyTextBox.Value", "Customer", null);

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionkey contains a null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionkey is not serializable.
System..::..ArgumentNullExceptiongroup contains a null reference (Nothing in Visual Basic).

See Also