Task Pool API Reference
Task pool library
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 fuction release all underlying resources. After calling this function, any job scheduled but not yet executed will be cancelled and destroyed. The taskPool instance will no longer be valid after this function returns.

Parameters
[in]taskPoolA 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:
IotTaskPool_t
struct _taskPool * IotTaskPool_t
Opaque handle of a Task Pool instance.
Definition: iot_taskpool_types.h:213
IotTaskPoolError_t
IotTaskPoolError_t
Return codes of task pool functions.
Definition: iot_taskpool_types.h:50
IotTaskPool_Destroy
IotTaskPoolError_t IotTaskPool_Destroy(IotTaskPool_t taskPool)
Destroys a task pool instance and collects all memory associated with a task pool and its satellite d...