Un-Scheduling a Job Instance

For any number of reasons, one might decide after after a job is in the scheduled state to remove it from the scheduled state before it naturally reaches the running state. This would correspond to the state change labeled ``Job is unscheduled'' in the state diagram detail of figure .

As is apparent from figure , this ``unscheduling state change'' can only occur if a GATJob is in the scheduled state. Otherwise, such an ``unscheduling state change'' is not defined.

One can effect such an ``unscheduling state change'' on a GATJob through a call to the function

GATResult GATJob_UnSchedule(GATJob_const object)

The function's first and only argument is the GATJob instance on wishes to unschedule. As is standard, this function returns a GATResult, covered in Appendix , which indicates its completion status. Upon successfully completing this function brings the passed GATJob, which must initially be in the scheduled state, in to the initial state. If the GATJob passed to this function is not in the scheduled state when passed, then this function will not complete successfully as the requested state change is undefined.