RegionLocalRemove Method (CacheableKey, IGFSerializable, IGFSerializable) |
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.CacheAssembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18
Syntaxpublic bool LocalRemove(
CacheableKey key,
IGFSerializable value,
IGFSerializable callbackArg
)
Public Function LocalRemove (
key As CacheableKey,
value As IGFSerializable,
callbackArg As IGFSerializable
) As Boolean
public:
bool LocalRemove(
CacheableKey^ key,
IGFSerializable^ value,
IGFSerializable^ callbackArg
)
member LocalRemove :
key : CacheableKey *
value : IGFSerializable *
callbackArg : IGFSerializable -> bool
Parameters
- key
- Type: GemStone.GemFire.CacheCacheableKey
the key of the entry to remove - value
- Type: GemStone.GemFire.CacheIGFSerializable
the value of the key to remove - callbackArg
- Type: GemStone.GemFire.CacheIGFSerializable
a user-defined parameter to pass to cache listeners and writers triggered by this method
Return Value
Type:
Booleantrue if entry with key and its value are removed otherwise false.
Exceptions
Remarks
No ICacheWriter is invoked.
Does not update any CacheStatistics.
See AlsoReference
[!:ICacheListener.AfterDestroy]
[!:ICacheWriter.BeforeDestroy]