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.CachingAssembly: Alachisoft.NCache.Web (in Alachisoft.NCache.Web.dll) Version: 4.1.0.0 (4.1.0.0)
Syntax
C# |
---|
public virtual Object Get( string key, DSReadOption dsReadOption, ref CacheItemVersion version ) |
Visual Basic |
---|
Public Overridable 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 ) |
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 object.
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.
Examples
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.
CopyC#
Cache cache = NCache.InitializeCache("myCache"); CacheItemVersion version = null; string textBoxValue = (string) cache.Get("MyTextBox.Value", DSReadOption.ReadThru, ref version);
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | key contains a null reference (Nothing in Visual Basic). |