TargetTypeDictionary.Remove(String) Method

Removes the element with the specified key from the IDictionary<TKey, TValue>.

Definition

Namespace: Sandcastle.Tools.BuildComponents.Targets
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.12.21.0

C#View SourceRequest Example
public bool Remove(
	string key
)

VBView SourceRequest Example
Public Function Remove ( 
	key As String
) As Boolean

C++View SourceRequest Example
public:
virtual bool Remove(
	String^ key
) sealed

F#View SourceRequest Example
abstract Remove : 
        key : string -> bool 
override Remove : 
        key : string -> bool 

Parameters

key String: The key of the element to remove.

Return Value

Boolean
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<TKey, TValue>.

Implements

IDictionary<TKey, TValue>.Remove(TKey)

Remarks

This method is not implemented as targets are never removed

Exceptions

ArgumentNullException	key is null.
NotSupportedException	The IDictionary<TKey, TValue> is read-only.