ISortCollection::Add method

Adds an item to the collection.

Syntax

HRESULT Add(
  [in] order  order,
  [in] PropId propertyId
);

Parameters

  • order [in]
    The order in which the objects are returned (for example, ascending or descending). For possible values, see the SortOrder enumeration.

  • propertyId [in]
    An identifier that uniquely identifies the property on which the returned list is sorted. For possible values, see the PropId enumeration.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

Remarks

The order in which you add the properties to the collection determines the sort order of the results. For example, the first property is the primary sort key, the second property is the secondary sort key, and so on.

Examples

For an example, see Filtering and Sorting Lists of Objects.

Requirements

Product

HPC Pack 2008 R2 Client Utilities, HPC Pack 2008 Client Utilities

Type library

Microsoft.Hpc.Scheduler.tlb

See also

ISortCollection