SetDocumentation.Remove Method

Sandcastle XML Comments

Sandcastle XML Comments Guide

SetDocumentationRemove Method

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

Namespace: XMLCommentsExamples.DocumentationInheritance
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0

Syntax

C++

Copy

public bool Remove(
	int item
)

Public Function Remove ( 
	item As Integer
) As Boolean

public:
virtual bool Remove(
	int item
) sealed

abstract Remove : 
        item : int -> bool 
override Remove : 
        item : int -> bool

Parameters

item: Type: SystemInt32
The object to remove from the ICollectionT.

Return Value

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

Implements

ICollectionTRemove(T)

Exceptions

Exception	Condition
NotSupportedException	The ICollectionT is read-only.

Reference

SetDocumentation Structure

XMLCommentsExamples.DocumentationInheritance Namespace

[v2014.5.31.0] Sandcastle XML Comments Guide

Send comments on this topic to [email protected]

previous page start next page