RtGetClockResolution

RtGetClockResolution obtains the resolution of the specified clock.

Syntax

Copy

BOOL RtGetClockResolution(
    [in]    CLOCK Clock,
    [out]   PLARGE_INTEGER pResolution
);

Parameters

[in] Clock

A clock identifier.

[out] pResolution

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

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

Requirements

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