ISchedulerJob::RemoveExcludedNodes method

Removes the specified nodes from the list of nodes that should not be used for the job.

Syntax

HRESULT RemoveExcludedNodes(
  [in] IStringCollection *NodeNames
);

Parameters

  • NodeNames [in]
    An IStringCollection interface that specifies the names of the nodes that you want to remove from the list of nodes on which the job should not run.

Return value

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

Remarks

To remove all of the nodes on the list of nodes that should not be used for the job from that list, use the ISchedulerJob::ClearExcludedNodes method.

If you specify a node that does not currently belong to the HPC cluster, an exception occurs. If you specify a node that is part of the HPC cluster but is not part of the current list of nodes that should not be used for the job, the ISchedulerJob::RemoveExcludedNodes method has no effect and no error occurs.

To verify that the method succeeded, check the value of the ISchedulerJob:ExcludedNodes property.

Requirements

Product

HPC Pack 2008 R2 Client Utilities

Type library

Microsoft.Hpc.Scheduler.tlb

See also

ISchedulerJob

ISchedulerJob::AddExcludedNodes

ISchedulerJob::ClearExcludedNodes

ISchedulerJob:ExcludedNodes