Defined in:Cancels a single job.
void CancelJob(Job *job);
||The job to cancel.|
CancelJobfunction cancels the job specified by the
jobparameter. If the job is in the executing state when this function is called, then a flag is set in the
Jobobject. The job's execution function must call the
Job::JobCancelledfunction to be aware of the cancellation, and it should exit early when it has been cancelled. (Jobs are not forced to exit by the Thread Manager.)
If the job has not yet begun executing when this function is called, then it is simply removed from the execution queue.