Page Comparison

OS_OBJ_QTY  OSQPendAbort (OS_Q    *p_q,

                          OS_OPT   opt,

                          OS_ERR  *p_err)

...

Description

Aborts and readies any tasks currently waiting on a message queue. This function should be used to fault-abort the wait on the message queue, rather than to signal the message queue via OSQPost().

Files

os.h/os_q.c

Prototype

Arguments

p_q

is a pointer to the queue for which pend(s) need to be aborted.

...

OSQPendAbort() returns the number of tasks made ready-to-run by this function. Zero indicates that no tasks were pending on the message queue, therefore this function had no effect.

Required Configuration

OS_CFG_Q_EN and OS_CFG_Q_PEND_ABORT_EN must be enabled in os_cfg.h. Refer to uC-OS-III Configuration Manual

Callers

Application.

Notes/Warnings

1. Queues must be created before they are used.

Example Usage