IScheduler::GetNodeIdList method

Retrieves a list of identifiers for the nodes in the cluster based on the specified filters.

Syntax

HRESULT GetNodeIdList(
  [in]  IFilterCollection *filterProperties,
  [in]  ISortCollection   *sortProperties,
  [out] IIntCollection    **pNodeIds
);

Parameters

  • filterProperties [in]
    An IFilterCollection interface that contains one or more filter properties used to filter the list of nodes. If NULL, the method returns all nodes.

  • sortProperties [in]
    An ISortCollection interface that contains one or more sort properties used to sort the list of nodes. If NULL, the list is not sorted.

  • pNodeIds [out]
    An IIntCollection interface that contains one or more node identifiers that match the specified filter criteria.

Return value

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

Remarks

If you specify more than one filter, a logical AND is applied to the filters (for example, return nodes that are reachable and have four sockets).

If you use the enumerator to enumerate each item in the collection, the item is a VARIANT of type VT_I4. Query the lVal member for the job identifier.

Requirements

Product

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

Type library

Microsoft.Hpc.Scheduler.tlb

See also

IScheduler

IScheduler::GetNodeList

IScheduler::OpenNode