Cache.Remove Method (System.Web.Caching)

Remove Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Cache..::.Remove Method

Updated: November 2007

Removes the specified item from the application's Cache object.

Namespace: System.Web.Caching
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

Public Function Remove ( _
    key As String _
) As Object

Visual Basic (Usage)

Dim instance As Cache
Dim key As String
Dim returnValue As Object

returnValue = instance.Remove(key)

public Object Remove(
    string key
)

Visual C++

public:
Object^ Remove(
    String^ key
)

public Object Remove(
    String key
)

JScript

public function Remove(
    key : String
) : Object

Parameters

key: Type: System..::.String
A String identifier for the cache item to remove.

Return Value

Type: System..::.Object

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

Examples

The following example creates a RemoveItemFromCache method. When this method is called, it uses the Item property to check whether the cache contains an object that is associated with a Key1 key value. If it does, the Remove method is called to remove the object.

Visual Basic

Public Sub RemoveItemFromCache(sender As Object, e As EventArgs)
    If (Not IsNothing(Cache("Key1"))) Then
      Cache.Remove("Key1")
    End If
End Sub

public void RemoveItemFromCache(Object sender, EventArgs e) {
    if(Cache["Key1"] != null)
      Cache.Remove("Key1");
}

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information