SqlDictionary(TValue).Remove Method (String)

SqlDictionaryTValueRemove Method (String)

Removes the element with the specified key from the IDictionaryTKey, TValue.

Namespace: SandcastleBuilder.Components
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public bool Remove(
	string key
)

Public Function Remove ( 
	key As String
) As Boolean

public:
virtual bool Remove(
	String^ key
) sealed

abstract Remove : 
        key : string -> bool 
override Remove : 
        key : string -> bool

Parameters

key: Type: SystemString
The key of the element to remove.

Return Value

Type: Boolean
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionaryTKey, TValue.

Implements

IDictionaryTKey, TValueRemove(TKey)

Exceptions

Exception	Condition
ArgumentNullException	key is null.
NotSupportedException	The IDictionaryTKey, TValue is read-only.

Remarks

This method is not implemented

Reference

SqlDictionaryTValue Class

Remove Overload

SandcastleBuilder.Components Namespace