PxTaskResume()
Remove the scheduling inhibition.
- APPLIES TO
-
1.0.0
- SYNOPSIS
-
PxError_t PxTaskResume (PxTask_t TaskId);
- ARGUMENTS
|
- RETURN VALUES
-
-
PXROS error code
-
- ERROR CODES
-
PXERR_ACCESS_RIGHT
The calling task has not the right to resume other tasks
PXERR_GLOBAL_ILLEGAL_CORE
The requested task is not on the same core
PXERR_TASK_ILLRDYFUN
Invalid ready function detected
PXERR_TASK_ILLTASK
TaskId
is not a valid task object - DESCRIPTION
-
PxTaskResume removes the scheduling inhibition for the task.
- IMPLEMENTATION GUIDELINES
-
- Before call
-
-
The parameter
TaskId
must be a valid task object id. This id may be-
the calling task’s own id read by calling
PxGetId()
(V) -
the return value of a
PxTaskCreate()
call (V) -
the result of a nameserver query (V)
-
part of a message sent by another task (V)
-
-
The task object must be created on the same core as the caller runs on. The creator core id can be read with the macro
PxTaskCoreId
and the own core id withPxGetCoreId
(C). Additionally the task id may be checked withPxTaskCheck()
(F).
-
- After call
-
-
The function returns
PXERR_NOERROR
if the task could be resumed. Any other return value describes an error, which has to be interpreted (C).
-
- Best Practice
-
-
No restrictions.
-
- SEE ALSO
- USAGE
-
#include "pxdef.h" PxError_t err = PxTaskResume(TaskId); if (err != PXERR_NOERROR) { // Report error }