Share via


OALTimerUpdate (Windows Embedded CE 6.0)

1/5/2010

This function modifies the actual system tick period.

OALTimerUpdate should not be implemented except when you use OEMIdle, IL timing, or a profiling implementation.

Syntax

UINT32 OALTimerUpdate(
  UINT32 period,
  UINT32 margin
);

Parameters

  • period
    [in] Specifies the number of ticks in the new system tick period.
  • margin
    [in] Specifies the safe time range, in ticks, in which the timer can be modified without errors. If the end of the actual tick period is closer than the value in the margin parameter, the tick period is not changed. If the new system tick period is close to the actual tick period, the tick period shifts forward by the number of ticks specified in the margin parameter.

Return Value

This function always returns 0 if you extend the system tick period. If you shorten the system tick period, this function returns the number of new system tick periods that have elapsed since the start of the actual system tick period. You can use this return value to avoid system tick drift or to count the time the system spent in idle mode.

Requirements

Header oal_timer.h
Library Developer Implemented
Windows Embedded CE Windows CE 5.0 and later

See Also

Reference

Timer Functions