ImmutableDictionary<TKey,TValue>.SetItem(TKey, TValue) Method

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Source:

ImmutableDictionary_2.cs

Sets the specified key and value in the immutable dictionary, possibly overwriting an existing value for the key.

public:
 System::Collections::Immutable::ImmutableDictionary<TKey, TValue> ^ SetItem(TKey key, TValue value);

public System.Collections.Immutable.ImmutableDictionary<TKey,TValue> SetItem (TKey key, TValue value);

member this.SetItem : 'Key * 'Value -> System.Collections.Immutable.ImmutableDictionary<'Key, 'Value>

Public Function SetItem (key As TKey, value As TValue) As ImmutableDictionary(Of TKey, TValue)

Parameters

key

TKey

The key of the entry to add.

value

TValue

The key value to set.

Returns

ImmutableDictionary<TKey,TValue>

A new immutable dictionary that contains the specified key/value pair.

Remarks

If the specified key/value pair already exists in the dictionary, this method returns the existing instance of the dictionary. If the key already exists but has a different value, this method returns a new instance of the dictionary with the overwritten value.