hi_tde_cancel_job
The
The
Description
After creating a job by calling hi_tde_begin_job and before submitting the job by calling hi_tde_end_job, you can call this API to cancel the corresponding TDE job and the commands in the job.
Restrictions
- Before calling this API, call hi_tde_open to open the TDE device and call hi_tde_begin_job to obtain a valid job handle.
- This API cannot be called to cancel a job that has been submitted by calling hi_tde_end_job.
- A canceled job is no longer valid. You cannot add commands to the job submit the job.
- This API does not support multiple processes.
Parameters
Parameter |
Input/Output |
Description |
|---|---|---|
handle |
Input |
Handle to a TDE job. |
Returns
- 0: success
- Other values: failure. For details, see Return Codes for TDE Graphics Drawing.
Parent topic: TDE Graphics Drawing