www.beck-ipc.com

@CHIP-RTOS C Library - RTOS API


RTX_Get_Task_State

Get status information for a task specified by name.

int RTX_Get_Task_State ( const char far *taskname,
                         Task_StateData far *taskdata,
                         int far *error );

Parameters

taskname

Input parameter, pointer to 4 character unique name tag of the task whose state information is desired.

taskdata

Output parameter, pointer to a Task_StateData type structure, allocated by the user which will receive data.

error

Output parameter, pointer to 16 bit word to receive error code indicator: 0 on success, else error code.

Return Value

-1 ==> Failure, error code was output to error    In this case error code 0 means that Task Monitoring is not enabled.
Other ==> Task ID

Comments

The task monitoring mode must be enabled in order to obtain the taskCount member.

When only the task's state is needed, the alternative RTX_Get_Task_State_Ext() function can be used, which executes faster.

See Also

RTOS API

This library function invokes a RTOS software interrupt. 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
    V1.00V1.00V1.00V0.90V1.00

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


End of document