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

Syntax

C#
bool Remove(
	TKey key,
	TValue value,
	Object callbackArg
)
Visual Basic (Declaration)
Function Remove ( _
	key As TKey, _
	value As TValue, _
	callbackArg As Object _
) As Boolean
Visual C++
bool Remove (
	TKey key, 
	TValue value, 
	Object^ callbackArg
)

Parameters

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

Return Value

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

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.

Exceptions

ExceptionCondition
GemStone.GemFire.Cache.Generic..::IllegalArgumentExceptionif key is null
GemStone.GemFire.Cache.Generic..::CacheServerException If an exception is received from the Java cache server. Only for Native Client regions.
GemStone.GemFire.Cache.Generic..::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.
GemStone.GemFire.Cache.Generic..::TimeoutException if the operation timed out
GemStone.GemFire.Cache.Generic..::RegionDestroyedException if this region has been destroyed

See Also