RtGetClockTime

RtGetClockTime obtains the current value of the specified clock.

Syntax

Copy

BOOL RtGetClockTime(
    [in]    CLOCK Clock,
    [out]   PLARGE_INTEGER pTime
);

Parameters

[in] Clock

A clock identifier.

[out] pTime

A pointer to a LARGE_INTEGER structure in which to store the results.

Return Value

If the function succeeds, it returns TRUE. If invalid parameters are specified, it returns FALSE.

Remarks

RtGetClockTime obtains the value of the specified clock. The time is specified in 100 ns units. See the table in the RtCreateTimer Comments section for a list of legal clock values.

When wRTOS is configured to use more than one processor on a multiprocessor computer, it should not matter on which processor RtGetClockTime is called. For this reason, if you want to trace the execution sequence of two events on different processors, Use QueryPerformanceCounter, instead of RtGetClockTime.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtApi.h	RtApi.lib (Windows), Startup.lib (RTSS)