Cluster.CreateTaskFromXmlFile Method

Article
04/17/2009

Creates a task using the specified XML file.

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

Usage

Syntax

'Declaration
Public Function CreateTaskFromXmlFile ( _
    path As String _
) As ITask

public ITask CreateTaskFromXmlFile (
    string path
)

public:
virtual ITask^ CreateTaskFromXmlFile (
    String^ path
) sealed

public final ITask CreateTaskFromXmlFile (
    String path
)

public final function CreateTaskFromXmlFile (
    path : String
) : ITask

Parameters

path
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.

Return Value

An ITask interface that represents the task.

Remarks

The initial state of the task is NotSubmitted (see TaskStatus). 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.

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