Share via


ICluster::CreateTaskFromXml method

Creates a task using the specified XML document.

Syntax

HRESULT CreateTaskFromXml(
  [in]  BSTR  xmlDocument,
  [out] ITask **pRetVal
);

Parameters

  • xmlDocument [in]
    An XML string that defines the task to create. For information about writing the XML string, 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::CreateTask

ICluster::CreateTaskFromXmlFile

ICluster::ExecuteCommand

IJob::AddTask