DictionaryExtensionsTryRemoveTKey, TValue(IDictionaryTKey, TValue, TKey, TValue) Method

Tries to remove and return the value with the specified key from the specified dictionary. The operation is thread safe if dictionary is a ThreadSafeDictionaryTKey, TValue, ConcurrentDictionaryTKey, TValue or LockingDictionaryTKey, TValue instance. For other IDictionaryTKey, TValue implementations the caller should care about thread safety if needed.

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0

C#

public static bool TryRemove<TKey, TValue>(
	this IDictionary<TKey, TValue> dictionary,
	TKey key,
	out TValue value
)

VB

<ExtensionAttribute>
Public Shared Function TryRemove(Of TKey, TValue) ( 
	dictionary As IDictionary(Of TKey, TValue),
	key As TKey,
	<OutAttribute> ByRef value As TValue
) As Boolean

C++

public:
[ExtensionAttribute]
generic<typename TKey, typename TValue>
static bool TryRemove(
	IDictionary<TKey, TValue>^ dictionary, 
	TKey key, 
	[OutAttribute] TValue% value
)

F#

[<ExtensionAttribute>]
static member TryRemove : 
        dictionary : IDictionary<'TKey, 'TValue> * 
        key : 'TKey * 
        value : 'TValue byref -> bool

Parameters

dictionary IDictionaryTKey, TValue: The target dictionary.
key TKey: Key of the item to remove.
value TValue: When this method returns, contains the value removed from the ThreadSafeDictionaryTKey, TValue, or the default value of the TValue type if dictionary is read-only or key does not exist.

Type Parameters

TKey: The type of the keys in the dictionary.
TValue: The type of the values in the dictionary.

Return Value

Boolean
if the element is successfully removed; otherwise, .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IDictionaryTKey, TValue. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullException

dictionary or key is .