Rev.1.00 2007.11.1
REC10B0002-0100
43
__DestroyTimer
Synopsis <Discard settings of timer mode>
Boolean __DestroyTimer(unsigned long data)
data Setup data
Description Discards settings of the timer that is set to specified timer mode.
[data]
For data, the following definition values can be set.
RAPI_TIMER_A0 Selects timer A channel 0.
RAPI_TIMER_A1 Selects timer A channel 1.
RAPI_TIMER_A2 Selects timer A channel 2
RAPI_TIMER_A3 Selects timer A channel 3.
RAPI_TIMER_A4 Selects timer A channel 4.
RAPI_TIMER_B0 Selects timer B channel 0.
RAPI_TIMER_B1 Selects timer B channel 1.
RAPI_TIMER_B2 Selects timer B channel 2.
RAPI_TIMER_B3 Selects timer B channel 3.
RAPI_TIMER_B4 Selects timer B channel 4.
RAPI_TIMER_B5 Selects timer B channel 5.
Return value
If the timer specification is incorrect, RAPI_FALSE is returned; otherwise, RAPI_TRUE
is returned.
Functionality Timer (timer mode)
Reference __CreateTimer, __EnableTimer
Remark •
If an undefined value is specified in the argument, operation of the API cannot be
guaranteed.
Program example
#include "rapi_timer_m16c_62p.h"
void func( void )
{
/* Destroy the setting of timer A2 as timer mode */
__DestroyTimer( RAPI_TIMER_A2 );
}