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)
Syntax
'Declaration
Public Function Add ( _
name As String, _
sortType As SortType _
) As Integer
public int Add(
string name,
SortType sortType
)
public:
int Add(
String^ name,
SortType sortType
)
member Add :
name:string *
sortType:SortType -> int
public function Add(
name : String,
sortType : SortType
) : int
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.
Exceptions
| Exception | Condition |
|---|---|
| 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. |
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.