Method Remove
Remove(TAlternateKey)
Removes the entry with the specified alternate key from the dictionary.
Declaration
public bool Remove(TAlternateKey key)Parameters
| Type | Name | Description |
|---|---|---|
| TAlternateKey | key | The alternate key of the entry to remove. |
Returns
| Type | Description |
|---|---|
| bool |
Exceptions
| Type | Condition |
|---|---|
| ObjectDisposedException | The dictionary has been disposed. |
Remove(TAlternateKey, out TKey, out TValue)
Removes the entry with the specified alternate key from the dictionary.
Declaration
public bool Remove(TAlternateKey key, out TKey actualKey, out TValue value)Parameters
| Type | Name | Description |
|---|---|---|
| TAlternateKey | key | The alternate key of the entry to remove. |
| TKey | actualKey | When this method returns, contains the key instance that was stored in the dictionary if the entry was found; otherwise the default value. |
| TValue | value | When this method returns, contains the value that was removed if the entry was found and its value was still available; otherwise null. |
Returns
| Type | Description |
|---|---|
| bool |
Exceptions
| Type | Condition |
|---|---|
| ObjectDisposedException | The dictionary has been disposed. |