IRegion(TKey, TValue).Remove Method (TKey, TValue, Object)

IRegionTKey, TValueRemove Method (TKey, TValue, Object)

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

Namespace: GemStone.GemFire.Cache.Generic
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18

Syntax

bool Remove(
	TKey key,
	TValue value,
	Object callbackArg
)

Function Remove ( 
	key As TKey,
	value As TValue,
	callbackArg As Object
) As Boolean

bool Remove(
	TKey key, 
	TValue value, 
	Object^ callbackArg
)

abstract Remove : 
        key : 'TKey * 
        value : 'TValue * 
        callbackArg : Object -> bool

key: Type: TKey
the key of the entry to Remove
value: Type: TValue
the value of the entry to Remove
callbackArg: Type: SystemObject
the callback for user to pass in, It can also be null

Type: Boolean
true if entry with key and its value are removed otherwise false.

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

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

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

Does not update any CacheStatistics.

[!:ICacheListener.AfterDestroy]

[!:ICacheWriter.BeforeDestroy]