ImmutableInterlocked.TryRemove<TKey,TValue> Method

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Package:

System.Collections.Immutable v9.0.0-preview.3.24172.9

Source:

ImmutableInterlocked.cs

Removes the element with the specified key, if the key exists.

public:
generic <typename TKey, typename TValue>
 static bool TryRemove(System::Collections::Immutable::ImmutableDictionary<TKey, TValue> ^ % location, TKey key, [Runtime::InteropServices::Out] TValue % value);

public static bool TryRemove<TKey,TValue> (ref System.Collections.Immutable.ImmutableDictionary<TKey,TValue> location, TKey key, out TValue value);

static member TryRemove : ImmutableDictionary * 'Key * 'Value -> bool

Public Shared Function TryRemove(Of TKey, TValue) (ByRef location As ImmutableDictionary(Of TKey, TValue), key As TKey, ByRef value As TValue) As Boolean

Type Parameters

TKey

The type of the keys contained in the collection.

TValue

The type of the values contained in the collection.

Parameters

location

ImmutableDictionary<TKey,TValue>

The dictionary to update.

key

TKey

The key to remove.

value

TValue

Receives the value of the removed item, if the dictionary is not empty.

Returns

Boolean

true if the key was found and removed; otherwise, false.