IScheduler::GetNodeList method

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

Syntax


HRESULT GetNodeList(
  [in]  IFilterCollection    *filterProperties,
  [in]  ISortCollection      *sortProperties,
  [out] ISchedulerCollection **pNodes
);

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.

pNodes [out]

An ISchedulerCollection interface that contains one or more node objects that match the specified filter criteria. Each item in the collection is a variant of type VT_DISPATCH. Query the pdispVal member for the ISchedulerNode interface.

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).

Examples

For an example, see Getting a List of Nodes in the Cluster.

Requirements

Product

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

Type library

Microsoft.Hpc.Scheduler.tlb

See also

IScheduler
IScheduler::GetNodeIdList

 

 

Show: