ICluster::CreateTaskFromXmlFile method

Creates a task using the specified XML file.

Syntax


HRESULT CreateTaskFromXmlFile(
  [in]  BSTR  path,
  [out] ITask **pRetVal
);

Parameters

path [in]

The absolute path to the XML file that contains the task to create. The file name should include the .xml extension. The XML file must contain a single Task element. For information about writing the XML document, see Task Schema.

pRetVal [out]

An ITask interface that represents the task.

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, call the ICluster::get_ErrorMessage method.

Remarks

The initial state of the task is TaskStatus_NotSubmitted. To run the task, you must add the task to a job or use a command to execute the task. A task is queued or submitted when its parent job is queued or submitted.

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

Ccpapi.tlb

See also

ICluster
ICluster::AddTask
ICluster::CreateJob
ICluster::CreateJobFromXmlFile
ICluster::CreateTask
ICluster::CreateTaskFromXml
ICluster::ExecuteCommand
IJob::AddTask

 

 

Show: