IPC@CHIP® RTOS-LNX – API Documentation

Header image

Main page

◆ RTX_Task_Priority()

int RTX_Task_Priority ( RTX_ID  taskId,
int  priority 

This API changes and/or reads out a task's priority.

To make a read-only call with no priority change, set the priority argument to PRIORITY_READ_ONLY.

The existing task priority returned by this API is the task's native priority and this return value does not reflect any momentary priority boost which this task may be receiving due to a priority inheritance semaphore access.

taskIdTask handle specifying task whose priority is to be changed. This parameter may be set to zero to indicate the current task.
priorityTask priority, ranging from 0 (highest) up to 90 (lowest). Or set to PRIORITY_READ_ONLY if no change is desired.
Positive value: Existing task priority before change
Negative value: An RTX error code.
On the @CHIP-RTOS-LNX this API has the following restriction: It's only allowed to change the priority of tasks that are located within the same process/executable.
See also

Top of page | Main page

Copyright © 2018 Beck IPC GmbH
Generated on Fri Jun 8 2018 12:48:21 by Doxygen 1.8.13