Retrieves the specified item from the Cache object. If the object is read through the data source,
put it against the given group and sub group.
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, string group, string subGroup, DSReadOption dsReadOption ) |
Visual Basic |
---|
Public Overridable Function Get ( _ key As String, _ group As String, _ subGroup As String, _ dsReadOption As DSReadOption _ ) As Object |
Visual C++ |
---|
public: virtual Object^ Get( String^ key, String^ group, String^ subGroup, DSReadOption dsReadOption ) |
Parameters
- key
- Type: System..::..String
The identifier for the cache item to retrieve.
- group
- Type: System..::..String
The name of the group which the item belongs to.
- subGroup
- Type: System..::..String
The name of the subGroup within a group.
- dsReadOption
- Type: Alachisoft.NCache.Web.Caching..::..DSReadOption
Options regarding reading from data source.
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", "Customer", null, DSReadOption.ReadThru);
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | key contains a null reference (Nothing in Visual Basic). |
System..::..ArgumentNullException | group contains a null reference (Nothing in Visual Basic). |