Removes the value with the specified key in the local cache only. Remove removes not only the value but also the key and entry from this region.

Namespace: GemStone.GemFire.Cache
Assembly:  GemStone.GemFire.Cache (in GemStone.GemFire.Cache.dll)
Version: 3.6.4.0

Syntax

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

Parameters

key
CacheableKey
the key of the entry to remove
value
Serializable
the value of the key to remove

Return Value

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

Remarks

No ICacheWriter is invoked.

Does not update any CacheStatistics.

Exceptions

ExceptionCondition
GemStone.GemFire.Cache..::IllegalArgumentExceptionif key is null
GemStone.GemFire.Cache..::IllegalStateException if this region has mirroring enabled

See Also