Share via


TaskStatus Enumeration

Defines the task status constants.

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

Usage

Syntax

'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
<GuidAttribute("343577AE-8168-4f66-B3F1-F88760297355")> _
Public Enumeration TaskStatus
[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[GuidAttribute("343577AE-8168-4f66-B3F1-F88760297355")] 
public enum TaskStatus
[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[GuidAttribute(L"343577AE-8168-4f66-B3F1-F88760297355")] 
public enum class TaskStatus
/** @attribute SerializableAttribute() */ 
/** @attribute ComVisibleAttribute(true) */ 
/** @attribute GuidAttribute("343577AE-8168-4f66-B3F1-F88760297355") */ 
public enum TaskStatus
SerializableAttribute 
ComVisibleAttribute(true) 
GuidAttribute("343577AE-8168-4f66-B3F1-F88760297355") 
public enum TaskStatus

Members

Member name Description
Cancelled The task was canceled by the application. The application called the ICluster.CancelTask or ICluster.CancelTasks method to cancel the task. If the caller provided the reason for canceling the job, then the ITask.ErrorMessage method will contain that reason. This enumeration member represents a value of 5.
Failed The task failed due to an application error or a system error that occurred on the compute node. To get a description of the error, call the ITask.ErrorMessage method. This enumeration member represents a value of 4.
Finished The task successfully finished. This enumeration member represents a value of 3.
NotSubmitted The parent job was added to the cluster but not to the scheduling queue. This enumeration member represents a value of 0.
Queued The parent job was added to the scheduling queue. This enumeration member represents a value of 1.
Running The task is running. This enumeration member represents a value of 2.

Remarks

To use this enumeration in Visual Basic Scripting Edition (VBScript), you need to use the numeric values for the enumeration members or create constants that correspond to those members and set them equal to the numeric values. The following code example shows how to create and set constants for this enumeration in VBScript.

const NotSubmitted = 0
const Queued = 1
const Running = 2
const Finished = 3
const Failed = 4
const Cancelled = 5

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

See Also

Reference

Microsoft.ComputeCluster Namespace
ITask.Status Property