Click or drag to resize
IRegionTKey, TValueDestroyRegion Method (Object)
Destroys the whole distributed region and provides a user-defined parameter object to any ICacheWriter invoked in the process.

Namespace: GemStone.GemFire.Cache.Generic
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18
Syntax
Copy
void DestroyRegion(
	Object callbackArg
)

Parameters

callbackArg
Type: SystemObject
a user-defined parameter to pass to callback events triggered by this call
Exceptions
ExceptionCondition
CacheWriterException if a CacheWriter aborts the operation; if this occurs some subregions may have already been successfully destroyed.
CacheListenerException if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated
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
Remarks

Destroy cascades to all entries and subregions. After the destroy, this region object can not be used any more. Any attempt to use this region object will get a RegionDestroyedException The region destroy not only destroys the local region but also destroys the server region. For local region instance - destroys the whole local region only For distributed region instance - destroys the whole local region and this operation is also propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

See Also