...
determines the type of abort performed.
OS_OPT_PEND_ABORT_1
Aborts the pend of only the highest priority task waiting on the event flag group.
OS_OPT_PEND_ABORT_ALL
Aborts the pend of all the tasks waiting on the event flag group.
OS_OPT_POST_NO_SCHED
Specifies that the scheduler should not be called even if the pend of a higher priority task is aborted. Scheduling will need to occur from another function.
You would use this option if the task calling OSFlagPendAbort()
will perform additional pend aborts, rescheduling will take place at completion, and when multiple pend aborts are to take effect simultaneously.
p_err
is a pointer to a variable that holds an error code. OSFlagPendAbort()
sets *p_err
to one of the following:
OS_ERR_NONE
at least one task waiting on the event flag group was readied and informed of the aborted wait. The return value indicates the number of tasks where a wait on the event flag group was aborted.
OS_ERR_OBJ_PTR_NULL
If OS_CFG_ARG_CHK_EN
is set to 1
in os_cfg.h
: if p_grp
is a NULL
pointer.
...
If OS_CFG_CALLED_FROM_ISR_CHK_EN
set to 1
in os_cfg.h
: This function cannot be called from an ISR.
OS_ERR_PEND_ABORT_NONE
No task was aborted since no task was waiting.
Returned Value
OSFlagPendAbort()
returns the number of tasks made ready-to-run by this function. Zero indicates that no tasks were pending on the event flag group and thus this function had no effect.
...