TargetTypeDictionaryRemove(KeyValuePairString, Target) Method

Removes the first occurrence of a specific object from the ICollectionT.

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(
	KeyValuePair<string, Target> item
)

VBView Source Request Example

Public Function Remove ( 
	item As KeyValuePair(Of String, Target)
) As Boolean

C++View Source Request Example

public:
virtual bool Remove(
	KeyValuePair<String^, Target^> item
) sealed

F#View Source Request Example

abstract Remove : 
        item : KeyValuePair<string, Target> -> bool 
override Remove : 
        item : KeyValuePair<string, Target> -> bool

Parameters

item KeyValuePairString, Target: The object to remove from the ICollectionT.

Return Value

Boolean
if item was successfully removed from the ICollectionT; otherwise, . This method also returns if item is not found in the original ICollectionT.

Implements

ICollectionTRemove(T)

Remarks

This method is not implemented as targets are never removed

Exceptions

NotSupportedException

The ICollectionT is read-only.