Destroys the whole distributed region and provides a user-defined parameter
object to any ICacheWriter invoked in the process.
Namespace: GemStone.GemFire.Cache
Assembly: GemStone.GemFire.Cache (in GemStone.GemFire.Cache.dll)
Version: 2.7.0.1
Syntax
| C# |
|---|
public void DestroyRegion( IGFSerializable callback ) |
| Visual Basic (Declaration) |
|---|
Public Sub DestroyRegion ( _ callback As IGFSerializable _ ) |
| Visual C++ |
|---|
public: void DestroyRegion ( IGFSerializable^ callback ) |
Parameters
- callback
- IGFSerializable
a user-defined parameter to pass to callback events triggered by this call
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.
Does not update any CacheStatistics.
Exceptions
| Exception | Condition |
|---|---|
| GemStone.GemFire.Cache..::CacheWriterException | if a CacheWriter aborts the operation; if this occurs some subregions may have already been successfully destroyed. |
| GemStone.GemFire.Cache..::CacheListenerException | if CacheListener throws an exception; if this occurs some subregions may have already been successfully invalidated |
| 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..::TimeoutException | if the operation timed out |
See Also
