Region.LocalRemove Method (CacheableKey, Serializable)

RegionLocalRemove Method (CacheableKey, Serializable)

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

Syntax

public bool LocalRemove(
	CacheableKey key,
	Serializable value
)

Public Function LocalRemove ( 
	key As CacheableKey,
	value As Serializable
) As Boolean

public:
bool LocalRemove(
	CacheableKey^ key, 
	Serializable^ value
)

member LocalRemove : 
        key : CacheableKey * 
        value : Serializable -> bool

key: Type: GemStone.GemFire.CacheCacheableKey
the key of the entry to remove
value: Type: GemStone.GemFire.CacheSerializable
the value of the key to remove

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

Exceptions

Exception	Condition
IllegalArgumentException	if key is null
IllegalStateException	if this region has mirroring enabled

Remarks

No ICacheWriter is invoked.

Does not update any CacheStatistics.

[!:ICacheListener.AfterDestroy]

[!:ICacheWriter.BeforeDestroy]