Region.Destroy Method (CacheableKey, IGFSerializable)

RegionDestroy Method (CacheableKey, IGFSerializable)

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: 9.0.6.18

Syntax

public void Destroy(
	CacheableKey key,
	IGFSerializable cacheWriterArg
)

Public Sub Destroy ( 
	key As CacheableKey,
	cacheWriterArg As IGFSerializable
)

public:
void Destroy(
	CacheableKey^ key, 
	IGFSerializable^ cacheWriterArg
)

member Destroy : 
        key : CacheableKey * 
        cacheWriterArg : IGFSerializable -> unit

key: Type: GemStone.GemFire.CacheCacheableKey
the key of the entry to destroy
cacheWriterArg: Type: GemStone.GemFire.CacheIGFSerializable
a user-defined parameter to pass to cache writers triggered by this method

Exceptions

Exception	Condition
IllegalArgumentException	if key is null
CacheServerException	If an exception is received from the Java cache server. Only for Native Client regions.
NotConnectedException	if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
TimeoutException	if the operation timed out
RegionDestroyedException	if this region has been destroyed

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.

[!:ICacheListener.AfterDestroy]

[!:ICacheWriter.BeforeDestroy]