Dictionary<TKey,TValue>.AlternateLookup<TAlternateKey>.Remove Method

Definition

Namespace:

System.Collections.Generic

Assembly:

System.Collections.dll

Overloads

Remove(TAlternateKey)	Removes the value with the specified alternate key from the Dictionary<TKey,TValue>.
Remove(TAlternateKey, TKey, TValue)	Removes the value with the specified alternate key from the Dictionary<TKey,TValue>, and copies the element to the value parameter.

Remove(TAlternateKey)

Removes the value with the specified alternate key from the Dictionary<TKey,TValue>.

public:
 bool Remove(TAlternateKey key);

public bool Remove (TAlternateKey key);

member this.Remove : 'AlternateKey -> bool

Public Function Remove (key As TAlternateKey) As Boolean

Parameters

key

TAlternateKey

The alternate key of the element to remove.

Returns

Boolean

true if the element is successfully found and removed; otherwise, false.

Exceptions

ArgumentNullException

key is null.

Remove(TAlternateKey, TKey, TValue)

Removes the value with the specified alternate key from the Dictionary<TKey,TValue>, and copies the element to the value parameter.

public:
 bool Remove(TAlternateKey key, [Runtime::InteropServices::Out] TKey % actualKey, [Runtime::InteropServices::Out] TValue % value);

public bool Remove (TAlternateKey key, out TKey actualKey, out TValue value);

member this.Remove : 'AlternateKey * 'Key * 'Value -> bool

Public Function Remove (key As TAlternateKey, ByRef actualKey As TKey, ByRef value As TValue) As Boolean

Parameters

key

TAlternateKey

The alternate key of the element to remove.

actualKey

TKey

When this method returns, contains the removed key.

value

TValue

When this method returns, contains the removed element.

Returns

Boolean

true if the element is successfully found and removed; otherwise, false.

Exceptions

ArgumentNullException

key is null.