RtGetClockTimerPeriod

RtGetClockTimerPeriod obtains the minimum timer period of the specified clock. The RtGetClockTimecall 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 Values

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.

Requirements

Header	Rtapi.h
Library	Rtx_Rtss.lib