RtGetSystemTimes

RtGetSystemTimes retrieves an array of system timing information. On a multiprocessor system, values in each of the FILETIME structures will contain system timing information for a given RTSS core.

NOTE: RtGetSystemTimes is only supported in the RTSS environment. It cannot be called from a Windows application linked to RTX64.

Syntax

BOOL RtGetSystemTimes(
    LPFILETIME lpCoreIdleTime,
    LPFILETIME lpCoreExecuteTime,
    ULONG lpSize
);

Parameters

lpIdleTime

Pointer to the array of FILETIME structure that receives the amount of time that each RTSS core has been idle.

lpExecuteTime

Pointer to the array of FILETIME structure that receives the total amount of time that each RTSS core has spent executing code in RTSS processes and threads.

lpSize

This parameter specifies the size in bytes of the arrays for the parameters lpIdleTime or lpExecuteTime.

If the lpIdleTime and lpExecuteTime parameters are NULL, this parameter receives the required array size of FILETIME structures in bytes.

Return Value

Returns TRUE if the function succeeds; returns FALSE if the function fails.

Remarks

All times are expressed using FILETIME data structures. Such a structure contains two 32-bit values that combine to form a 64-bit count of 100-nanosecond units.

First, call this function with the lpIdleTime and lpExecuteTime parameters to NULL to determine maximum array size of FILETIME structures in bytes required.

In the list of arrays with FILETIME information, index 0 is equal to the process number (also 0-based). Index 1 would contain the FILETIME information of the corresponding processor. In a 64-processor system, index 0 through 63 identify Processors 0 through Processor 63.

For example, in an 8-processor system if 4 cores are assigned to Windows and the remaining 4 cores are dedicated to RTSS, the index values from 4 through 7 contain the FILETIME information of the RTSS cores, respectively.

Requirements

Minimum Supported Version RTX64 3.5
Header RtssApi.h
Library RtAPI.lib(Windows), Rtx_Rtss.lib(RTSS)

See Also: