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

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

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 kernel’s HAL timer period, the overhead of kernel 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 50 us, depending on your processor frequency.

See Also:

• RtCancelTimer
• RtCreateTimer
• RtDeleteTimer
• RtGetClockResolution
• RtGetClockTime
• RtSetClockTime
• RtSetTimer
• RtSetTimerRelative