OSA : OS_Qtimer_Delete

OS_Qtimer_Delete (qtimer)

Not allowed in interrupt

Delete timer from queue of timers. Timeout flag remains unchanged.

OS_ENABLE_QTIMERS constant must be defined in OSAcfg.h. Size of timers is set by OS_QTIMER_SIZE constant

Call allowed:

Not in interrupt

Parameters:

qtimer Descriptor of timer. Variable of OST_QTIMER 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_QTIMER qtimer;
 
void Task (void)
{
    OS_Qtimer_Create(qtimer);       // Add timer in list
    for (;;) {
        /*...*/
        OS_Qtimer_Delete (qtimer);  // Delete timer before destroying task
        OS_Task_Stop();             // Destroy task
        /*...*/
    }
}

See also

Back to top