Click or drag to resize
IRegionTKey, TValueRemove Method (TKey)
Removes the element with the specified key from the IDictionary.

Namespace: GemStone.GemFire.Cache.Generic
Assembly: Gemstone.Gemfire.Cache (in Gemstone.Gemfire.Cache.dll) Version: 9.0.6.18
Syntax
Copy
bool Remove(
	TKey key
)

Parameters

key
Type: TKey
The key of the element to remove.

Return Value

Type: Boolean
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary.

Implements

IDictionaryTKey, TValueRemove(TKey)
Exceptions
ExceptionCondition
IllegalArgumentExceptionif key is null
EntryNotFoundException if the entry does not exist in this region locally, applicable only for local region instance.
CacheServerException If an exception is received from the Java cache server. Only for Native Client regions.
NotConnectedException if not connected to the GemFire system because the client cannot establish usable connections to any of the servers given to it. For pools configured with locators, if no locators are available, innerException of NotConnectedException is set to NoAvailableLocatorsException.
TimeoutException if the operation timed out
RegionDestroyedException if this region has been destroyed
Remarks
For local region instance - removes the entry with the specified key from the local cache only. For distributed region instance - remove is propogated to the Gemfire cache server.
See Also