DataCache.Remove Method (String, DataCacheItemVersion)

Article
08/26/2011

Indicates whether the object from the cache is removed.

Namespace: Microsoft.ApplicationServer.Caching
Assembly: Microsoft.ApplicationServer.Caching.Client (in microsoft.applicationserver.caching.client.dll)

Usage

'Usage
Dim instance As DataCache
Dim key As String
Dim version As DataCacheItemVersion
Dim returnValue As Boolean

returnValue = instance.Remove(key, version)

Syntax

'Declaration
Public Function Remove ( _
    key As String, _
    version As DataCacheItemVersion _
) As Boolean

public bool Remove (
    string key,
    DataCacheItemVersion version
)

public:
bool Remove (
    String^ key, 
    DataCacheItemVersion^ version
)

public boolean Remove (
    String key, 
    DataCacheItemVersion version
)

public function Remove (
    key : String, 
    version : DataCacheItemVersion
) : boolean

Parameters

key
The unique value that is used to identify the object in the region.

version
The DataCacheItemVersion object that represents the version of the cached object that is to be removed.

Return Value

True if the object is removed; otherwise, false.

Remarks

This method supports optimistic concurrency by only removing the object having the DataCacheItemVersion value specified with the version parameter. If another process updates this object before the method call, the object is not removed. For more information about how to use this method, see How to: Remove an Object from Cache.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Visual Studio 2010 and later, .NET Framework 4

Target Platforms

Windows 7; Windows Server 2008 R2; Windows Server 2008 Service Pack 2; Windows Vista Service Pack 2