PRD_stop
2-296
C Interface
Syntax
PRD_stop(prd);
Parameters
PRD_Handle prd;
/* prd object handle*/
Return Value
Void
Reentrant
no
Description
PRD_stop stops a period object to prevent its function execution. In most
cases, PRD_stop is used to stop a period object that has its mode
property set to one-shot in the configuration.
Unlike PRD objects that are configured as continuous, one-shot PRD
objects do not automatically continue to run. A one-shot PRD object runs
its function only after the specified numbers of ticks have occurred after
a call to PRD_start.
PRD_stop is the way to stop those one-shot PRD objects once started
and before their period counters have run out.
Example
PRD_stop(&prd);
See Also
PRD_getticks
PRD_start
PRD_tick
PRD_stop
Stop a period object to prevent its function execution