IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


RTX_EC RTX_Task_Info ( const char *  taskname,
sTASK_INFO taskdata,
unsigned int  dataSize,
BOOL  measureStack 
)

This API reports detailed information concerning a task specified by name.

The measureStack Boolean controls whether or not the task's stack space is scanned to detect the high water mark. This scan can be time consuming.

The RTX_Task_Info_By_Id() API can be used to report task details for a task specified by handle ID.

Parameters:
taskname Name of task whose information is to be reported.
taskdata Output Parameter: Task specifics are reported here.
dataSize For future compatibility, set to sizeof(sTASK_INFO).
measureStack Boolean, non-zero if task's stack usage should be measured.
Returns:
Zero on success, else error code.
Compatibility:
This API is not available in the SC1x, SC2x and SC1x3 C-Library prior to year 2017. The deprecated RTX_Get_Task_State() API can be used as an alternative when compatibility with the older Beck systems is required.
See also:
RTX_Task_Info_By_Id()     RTX_Get_Task_List()     RTX_Wait_Queue()
Since:
SC2x3 V1.00 - CLIB V1.00





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:37 2017 by Doxygen 1.6.1