AsyncBaseClass.AsyncRemoveJob (METH)

METHOD AsyncRemoveJob : RTS_IEC_RESULT

Method to remove a job.

InOut:

Scope

Name

Type

Comment

Return

AsyncRemoveJob

RTS_IEC_RESULT
Returns the runtime system error code (see CmpErrors.library):

  • ERR_OK: Job has been successfully removed

  • ERR_FAILED: Job cannot be removed because it has been started

  • ERR_PARAMETER: hJob is invalid

  • ERR_PENDING: Job cannot be removed because it is active

Input

hJob

RTS_IEC_HANDLE

Handle to the job object.