IScheduler::GetActiveHeadNode method

  • Article

Retrieves the name of the active head node.

Syntax

HRESULT GetActiveHeadNode(
  [out] BSTR *headnodeName
);

Parameters

  • headnodeName [out]
    Retrieves a String that contains the name of the active head node.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code. To get a description of the error, access the ISchedulerJob::ErrorMessage property.

Requirements

Product

This method was introduced in Windows HPC Pack 2012 and is not supported in previous versions.

Type library

 Microsoft.Hpc.Scheduler.tlb