JobState enumeration
Defines the state of the job.
Syntax
typedef enum {
JobState_Configuring = 1,
JobState_Submitted = 2,
JobState_Validating = 4,
JobState_ExternalValidation = 8,
JobState_Queued = 16,
JobState_Running = 32,
JobState_Finishing = 64,
JobState_Finished = 128,
JobState_Failed = 256,
JobState_Canceled = 512,
JobState_Canceling = 1024,
JobState_All = 2047
} JobState;
Constants
JobState_Configuring
The job is being configured. The job remains in the configuring state until you call the IScheduler::SubmitJob method to add the job to the scheduling queue.JobState_Submitted
The job was submitted to the scheduling queue (see SubmitJob) and is waiting to be validated.JobState_Validating
The server is determining if the job can run. If the server and external validation filters have successfully validated the job, it is then queued.JobState_ExternalValidation
A submission filter is determining if the job can run. For details, see the SubmissionFilterProgram cluster parameter in the Remarks section of IScheduler::SetClusterParameter.JobState_Queued
The job passed validation and was added to the scheduling queue.JobState_Running
The job is running.JobState_Finishing
The server is cleaning up the resources that were allocated to the job.JobState_Finished
The job successfully finished (all the tasks in the job finished successfully).JobState_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, access the ISchedulerJob::ErrorMessage job property.JobState_Canceled
The job was canceled (see IScheduler::CancelJob). If the caller provided the reason for canceling the job, then the ErrorMessage job property will contain the reason.JobState_Canceling
The job is being canceled.JobState_All
A mask used to indicate all states.
Remarks
A job can be in only one state. The states are specified as flags, so you can specify multiple states when filtering jobs. For example, you can retrieve jobs that are in both the Canceled and Finished states.
Requirements
Product |
HPC Pack 2008 R2 Client Utilities, HPC Pack 2008 Client Utilities |
Type library |
Microsoft.Hpc.Scheduler.Properties.tlb |