OSA : OS_Dtimer_Stop

OS_Dtimer_Stop (dtimer)

Stop dynamic timer. Timer will stay active but will not be incremented in OS_Timer(). Timeout flag stays unchanged (to set timeout flag see OS_Dtimer_Break).

OS_ENABLE_DTIMERS constant must be defined in OSAcfg.h. Size of dynamic timers is set by OS_DTIMER_SIZE constant

Call allowed:

Everywhere

Parameters:

dtimer Descriptor of dynamic timer. Variable of OST_DTIMER type. Contains timer counter, timer state flags and pointer to next timer in list. For PIC16, can only be allocated in bank0 or bank1

Returns:

nothing

Example:

OST_DTIMER dtimer;
 
void Task (void)
{
    for (;;) {
        /*...*/
        OS_Dtimer_Stop(dtimer);
        /*...*/
    }
}

Old style name

OS_StopDTimer

See also

Back to top