JobStatus Enumeration

Article
04/23/2009

Defines the job status constants.

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

Usage

Syntax

'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
<GuidAttribute("4DB2A200-F06F-4a3d-B165-ACFE4AA16BC2")> _
Public Enumeration JobStatus

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[GuidAttribute("4DB2A200-F06F-4a3d-B165-ACFE4AA16BC2")] 
public enum JobStatus

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
[GuidAttribute(L"4DB2A200-F06F-4a3d-B165-ACFE4AA16BC2")] 
public enum class JobStatus

/** @attribute SerializableAttribute() */ 
/** @attribute ComVisibleAttribute(true) */ 
/** @attribute GuidAttribute("4DB2A200-F06F-4a3d-B165-ACFE4AA16BC2") */ 
public enum JobStatus

SerializableAttribute 
ComVisibleAttribute(true) 
GuidAttribute("4DB2A200-F06F-4a3d-B165-ACFE4AA16BC2") 
public enum JobStatus

Members

Member name	Description
Cancelled	The job was canceled by the application. The application called the ICluster.CancelJob or ICluster.CancelJobs method to cancel the job. If the caller provided the reason for canceling the job, then the IJob.ErrorMessage method will contain that reason. This enumeration member represents a value of 5.
Failed	One or more of the tasks in the job failed or a system error occurred on the compute node. To get a description of the error, call the IJob.ErrorMessage method. This enumeration member represents a value of 4.
Finished	The job successfully finished (all the tasks in the job finished successfully). This enumeration member represents a value of 3.
NotSubmitted	The job was added to the cluster but not to the scheduling queue. The application called the ICluster.AddJob or ICluster.AddJobs method to add the job to the cluster. This enumeration member represents a value of 0.
Queued	The job was added to the scheduling queue. The application called the ICluster.SubmitJob, ICluster.SubmitJobs, ICluster.QueueJob, or ICluster.QueueJobs method to add the job to the scheduling queue. This enumeration member represents a value of 1.
Running	The job 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