www.beck-ipc.com

@CHIP-RTOS C Library - RTOS API


RTX_Task_Info

Get task information based on task name.

int far RTX_Task_Info ( const char far *taskName,
                            sTASK_INFO far *taskdata,
                            unsigned int dataSize,
                            int measureStack);

Parameters

taskName

Task name, up to 4 characters.

taskdata

Output parameter, pointer to sTASK_INFO type allocated by user and filled by this function.

dataSize

Should be set to sizeof(sTASK_INFO) for future compatibility.   (But currently this API ignores this parameter.)

measureStack

Boolean, set non-zero if a stack space measurement is desired.   (Note that these stack space scans may require some significant number of microseconds to complete, depending on the size of a stack.)

Return Value

0 on success else error code.

Comments

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.

See Also

RTOS API

This library function invokes a RTOS software interrupt to install a dynamic link into the RTOS. Refer to this RTOS API function's documentation for more details.

Related Topics

RTX API   Overview

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3SC2x
    n/an/an/aV2.04V2.04

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document