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.7.0.0

Syntax

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

Parameters

key
ICacheableKey
the key of the entry to destroy
cacheWriterArg
IGFSerializable
a user-defined parameter to pass to cache writers triggered by this method

Remarks

Destroy removes not only the value, but also the key and entry from this region.

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

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