IotTaskPool_Destroy

Destroys a task pool instance and collects all memory associated with a task pool and its satellite data structures.

IotTaskPoolError_t IotTaskPool_Destroy( IotTaskPool_t taskPool );

This function should be called to destroy one instance of a task pool previously created with a call to IotTaskPool_Create or IotTaskPool_CreateSystemTaskPool. Calling this function release all underlying resources. After calling this function, any job scheduled but not yet executed will be canceled and destroyed. The taskPool instance will no longer be valid after this function returns.

Parameters

[in]

taskPool

A handle to the task pool, e.g. as returned by a call to IotTaskPool_Create or IotTaskPool_CreateSystemTaskPool. The taskPool instance will no longer be valid after this function returns.

Returns

One of the following:

• IOT_TASKPOOL_SUCCESS
• IOT_TASKPOOL_BAD_PARAMETER