os_task_remove

int os_task_remove(struct os_task *t)

Removes a task, t, from the task list. A task cannot be removed when it is in one of the following states:

• It is running - a task cannot remove itself.
• It has not been initialized.
• It is holding a lock on a semphore or mutex.
• It is suspended waiting on a lock (semaphore or mutex) or for an event on an event queue.

Arguments

Returned values

OS_OK: Task t is removed sucessfully.
OS_INVALID_PARM: Task t is the calling task. A task cannot remove itself.
OS_NOT_STARTED: Task t is not initialized.
OS_EBUSY: Task t is either holding a lock or suspended waiting for a lock or an event.

Example

struct os_task worker_task;

int
remove_my_worker_task(void)
{
    /* Add error checking code to ensure task can removed. */

    /* Call os_task_remove to remove the worker task */
    rc = os_task_remove(&worker_task);
    return rc;
}