PxAbortSetup()

Prepare abort mechanism.

APPLIES TO

8.2.0

SYNOPSIS
PxEventsOrError_t PxAbortSetup(PxEvents_t events);
ARGUMENTS
events

Events that let the call abort

RETURN VALUES
  • If one of the aborting events is already received, no error status is returned.

  • An error code is returned if there is no abortstack free if the caller is not in user mode, or if the calling task’s stack is invalid.

ERROR CODES

PXERR_NOERROR

one of the aborting events is already received

PXERR_TASK_STACKOVERFLOW

calling task’s stack is too short

PXERR_TASK_ILLCALL

caller is not in user mode

PXERR_ABORTSTACK_OVERFLOW

no abortstack frame free

DESCRIPTION

PxAbortSetup prepare abort mechanism

IMPLEMENTATION GUIDELINES
Before call
  • No checks necessary.

After call
  • No checks necessary.

Best Practice
  • No restrictions.

SEE ALSO
USAGE
#include "pxdef.h"

PxEventsOrError_t EventsErr = PxAbortSetup(ev);

if (EventsErr.error != PXERR_NOERROR)
{
   //Report Error
}