ICluster.CreateJobFromXml Method

Article
04/17/2009

Creates a job using the specified XML document.

Namespace: Microsoft.ComputeCluster
Assembly: CcpAPI (in ccpapi.dll)

Usage

Syntax

'Declaration
Function CreateJobFromXml ( _
    xmlDocument As String _
) As IJob

IJob CreateJobFromXml (
    string xmlDocument
)

IJob^ CreateJobFromXml (
    String^ xmlDocument
)

IJob CreateJobFromXml (
    String xmlDocument
)

function CreateJobFromXml (
    xmlDocument : String
) : IJob

Parameters

xmlDocument
An XML string that defines the job to create. If the job contains tasks, the tasks are also created. For information about writing the XML string, see Job Schema.

Return Value

An IJob interface that represents the job.

Remarks

The initial state of the job is NotSubmitted (see JobStatus). After creating the job, call the ICluster.AddJob method to add the job to the cluster. If the XML did not contain tasks, then call the ICluster.AddTask or ICluster.AddTasks method to add one or more tasks to the job. When the job is ready (you have added all the tasks and set all the job terms), call the ICluster.SubmitJob method to add the job to the scheduling queue.

To add and submit the job in one step, call the ICluster.QueueJob method. Before calling the QueueJob method, call the IJob.AddTask method to add tasks to the job.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003, Windows XP

Target Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003 with Compute Cluster Pack Client Utilities, Windows XP with Compute Cluster Pack Client Utilities