Removes the object from the Cache.

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 virtual Object Remove(
	string key,
	DSWriteOption dsWriteOption,
	string providerName,
	DataSourceItemsRemovedCallback onDataSourceItemRemovedCallback
)
Visual Basic
Public Overridable Function Remove ( 
	key As String,
	dsWriteOption As DSWriteOption,
	providerName As String,
	onDataSourceItemRemovedCallback As DataSourceItemsRemovedCallback
) As Object
Visual C++
public:
virtual Object^ Remove(
	String^ key, 
	DSWriteOption dsWriteOption, 
	String^ providerName, 
	DataSourceItemsRemovedCallback^ onDataSourceItemRemovedCallback
)

Parameters

key
Type: System..::..String
The cache key used to reference the item.
dsWriteOption
Type: Alachisoft.NCache.Web.Caching..::..DSWriteOption
Options regarding updating the data source.
providerName
Type: System..::..String
Provider name.
onDataSourceItemRemovedCallback
Type: Alachisoft.NCache.Web.Caching..::..DataSourceItemsRemovedCallback
A delegate that, if provided, is called when item is removed from data source.

Return Value

Type: Object
The item removed from the Cache. If the value in the key parameter is not found, returns a null reference (Nothing in Visual Basic).

Remarks

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

Examples

The following example demonstrates how you can remove an item from your application's Cache object.
 Copy imageCopy
Cache cache = NCache.InitializeCache("myCache");
cache.Remove("timestamp", DSWriteOption.None, null, "group-name", "subGroup-name");

Exceptions

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

See Also