RtGetClockTimerPeriod

RtGetClockTimerPeriod obtains the minimum timer period of the specified clock. The RtGetClockTime call delivers the clock time as 64-bit quantity of 100ns.

Syntax

BOOL RtGetClockTimerPeriod(
    CLOCK Clock,
    PLARGE_INTEGER pTime
);

Parameters

Clock

A clock identifier.

pTime

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

Return Value

TRUE if the function completes successfully, FALSE if invalid parameters are specified

Remarks

RtGetClockTimerPeriod obtains the minimum timer period of the specified clock. Timers with an expiration interval smaller than this will produce unpredictable results. See the table in the RtCreateTimer Comments section for a list of legal clock values.

NOTE: If your timer period is close to Real-time subsystem’s HAL timer period, the overhead of Subsystem tick processing may cause a much larger response latency of your timer handling routine (IST). In this case, you should configure a much smaller HAL timer period. For example, if your timer period is 100 us, you should configure HAL period to a smaller value, such as 20 us, depending on your processor frequency. See the Control Panel for how to modify the Hal timer period.

Requirements

Minimum Supported Version	RTX64 2013
Header	Rtapi.h
Library	RtApi.lib (Windows), Rtx_Rtss.lib (RTSS)