This documentation is archived and is not being maintained.

SortFieldList::Add Method (String, SortType)

Adds a new SortField instance to this list that has the specified name and SortType.

Namespace:  Microsoft.TeamFoundation.WorkItemTracking.Client
Assembly:  Microsoft.TeamFoundation.WorkItemTracking.Client (in Microsoft.TeamFoundation.WorkItemTracking.Client.dll)

public:
int Add(
	String^ name, 
	SortType sortType
)

Parameters

name
Type: System::String

The name of the new SortField instance to add to this list.

sortType
Type: Microsoft.TeamFoundation.WorkItemTracking.Client::SortType

The SortType of the new SortField instance to add to this list.

Return Value

Type: System::Int32
The index of the newly added SortField instance or the index of an existing SortField that has the same field ID.

ExceptionCondition
ArgumentNullException

At least one of the parameters is null.

ArgumentException

The sortType parameter is not valid.

FieldDefinitionNotExistException

The name parameter does not resolve to an existing FieldDefinition.

Show: