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
Assembly:  GemStone.GemFire.Cache (in GemStone.GemFire.Cache.dll)
Version: 3.6.2.0

Syntax

C#
public bool Remove(
	CacheableKey key,
	IGFSerializable value
)
Visual Basic (Declaration)
Public Function Remove ( _
	key As CacheableKey, _
	value As IGFSerializable _
) As Boolean
Visual C++
public:
bool Remove (
	CacheableKey^ key, 
	IGFSerializable^ value
)

Parameters

key
CacheableKey
the key of the entry to Remove
value
IGFSerializable
the value of the entry to Remove

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..::IllegalArgumentExceptionif key is null
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. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
GemStone.GemFire.Cache..::TimeoutException if the operation timed out
GemStone.GemFire.Cache..::RegionDestroyedException if this region has been destroyed

See Also