Destroys the entry with the specified key, passing the callback argument to any cache writers that are invoked in the operation.

Namespace: GemStone.GemFire.Cache
Assembly:  GemStone.GemFire.Cache (in GemStone.GemFire.Cache.dll)
Version: 2.5.0.1

Syntax

C#
public void Destroy(
	ICacheableKey key
)
Visual Basic (Declaration)
Public Sub Destroy ( _
	key As ICacheableKey _
)
Visual C++
public:
void Destroy (
	ICacheableKey^ key
)

Parameters

key
ICacheableKey
the key of the entry to destroy

Remarks

Destroy removes not only the value, but also the key and entry from this region. @cacheserver Destroy will be distributed to other caches if the scope is not ScopeType.Local. @endcacheserver

@nativeclient

The destroy is propogated to the Gemfire cache server to which it is connected with.

@endnativeclient

Does not update any CacheStatistics.

Exceptions

ExceptionCondition
GemStone.GemFire.Cache..::IllegalArgumentExceptionif key is null
GemStone.GemFire.Cache..::CacheServerException If an exception is received from the Java cache server. Only for Native Client regions.
GemStone.GemFire.Cache..::NotConnectedException if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it.
GemStone.GemFire.Cache..::EntryNotFoundException if the entry does not exist in this region locally
GemStone.GemFire.Cache..::TimeoutException if the operation timed out
GemStone.GemFire.Cache..::RegionDestroyedException if this region has been destroyed

See Also