IotTaskPool_TryCancel

This function tries to cancel a job that was previously scheduled with IotTaskPool_Schedule.

IotTaskPoolError_t IotTaskPool_TryCancel( IotTaskPool_t taskPool,
                                          IotTaskPoolJob_t job,
                                          IotTaskPoolJobStatus_t * const pStatus );

A job can be canceled only if it is not yet executing, i.e. if its status is IOT_TASKPOOL_STATUS_READY or IOT_TASKPOOL_STATUS_SCHEDULED. Calling IotTaskPool_TryCancel on a job whose status is IOT_TASKPOOL_STATUS_COMPLETED, or IOT_TASKPOOL_STATUS_CANCELED will yield a IOT_TASKPOOL_CANCEL_FAILED return result.

Parameters

[in]	taskPool	A handle to the task pool that must have been previously initialized with a call to IotTaskPool_Create.
[in]	job	The job to cancel.
[out]	pStatus	The status of the job at the time of cancellation.

Returns

One of the following:

• IOT_TASKPOOL_SUCCESS
• IOT_TASKPOOL_BAD_PARAMETER
• IOT_TASKPOOL_SHUTDOWN_IN_PROGRESS
• IOT_TASKPOOL_CANCEL_FAILED

Warning

The taskPool used in this function should be the same used to create the job pointed to by job, or the results will be undefined.