TargetDictionaryRemove(String) Method

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

Definition

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

C#View Source Request Example

public bool Remove(
	string key
)

VBView Source Request Example

Public Function Remove ( 
	key As String
) As Boolean

C++View Source Request Example

public:
virtual bool Remove(
	String^ key
) sealed

F#View Source Request Example

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

Parameters

key String: The key of the element to remove.

Return Value

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

Implements

IDictionaryTKey, TValueRemove(TKey)

Remarks

This method is not implemented as targets are never removed

Exceptions

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