Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

at least one task waiting on the message queue was readied and informed of the aborted wait. Check the return value for the number of tasks whose wait on the message queue was aborted.

OS_ERR_PEND_ABORT_ISR

if OS_CFG_CALLED_FROM_ISR_CHK_EN set to 1 in os_cfg.h: if called from an ISR

OS_ERR_PEND_ABORT_NONE

if no task was pending on the message queue

OS_ERR_OBJ_PTR_NULL

if OS_CFG_ARG_CHK_EN is set to 1 in os_cfg.h: if p_q is a NULL pointer.

OS_ERR_OBJ_TYPE

if OS_CFG_OBJ_TYPE_CHK_EN is set to 1 in os_cfg.h: if p_q is not pointing to a message queue.

OS_ERR_OPT_INVALID

if OS_CFG_ARG_CHK_EN is set to 1 in os_cfg.h: if an invalid option is specified.

Returned Value

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.

...