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

Syntax

C#
public void Invalidate(
	ICacheableKey key
)
Visual Basic (Declaration)
Public Sub Invalidate ( _
	key As ICacheableKey _
)
Visual C++
public:
void Invalidate (
	ICacheableKey^ key
)

Parameters

key
ICacheableKey
key of the value to be invalidated

Remarks

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

@nativeclient

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

@endnativeclient

Does not update any CacheStatistics.

Exceptions

ExceptionCondition
GemStone.GemFire.Cache..::IllegalArgumentExceptionif key is null
GemStone.GemFire.Cache..::EntryNotFoundException if this entry does not exist in this region locally
GemStone.GemFire.Cache..::RegionDestroyedException if the region is destroyed

See Also