Region.Invalidate Method (ICacheableKey, IGFSerializable)

RegionInvalidate Method (ICacheableKey, IGFSerializable)

Invalidates the entry with the specified key, passing the callback argument to any cache listeners that are invoked in the operation.

Namespace: GemStone.GemFire.Cache
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18

Syntax

public void Invalidate(
	ICacheableKey key,
	IGFSerializable callback
)

Public Sub Invalidate ( 
	key As ICacheableKey,
	callback As IGFSerializable
)

public:
void Invalidate(
	ICacheableKey^ key, 
	IGFSerializable^ callback
)

member Invalidate : 
        key : ICacheableKey * 
        callback : IGFSerializable -> unit

key: Type: GemStone.GemFire.CacheICacheableKey
key of the value to be invalidated
callback: Type: GemStone.GemFire.CacheIGFSerializable
a user-defined parameter to pass to callback events triggered by this method

Exceptions

Exception	Condition
IllegalArgumentException	if key is null
EntryNotFoundException	if this entry does not exist in this region locally
RegionDestroyedException	if the region is destroyed

Remarks

Invalidate only removes the value from the entry -- the key is kept intact. To completely remove the entry, call Destroy(ICacheableKey, IGFSerializable).

The invalidate is not propogated to the Gemfire cache server to which it is connected with.

Does not update any CacheStatistics.

[!:ICacheListener.AfterInvalidate]