Usertimerstop, Syntax, Remarks – Rockwell Automation 6182 SDK User Manual
Page 78: Return value, Portability, See also, Usertimergetvalue
4–38
RAC6182-Specific Extensions to the CE API
Publication 6182-UM002B-EN-P
UserTimerStop
This function stops the user timer. It is prototyped in usertimers.h.
Syntax
#include
#include
DWORD UserTimerStop(DWORD TimerNumber)
Remarks
Aborts any currently active countdown in the timer specified by
TimerNumber. TimerNumber must refer to a previously claimed timer.
Return Value
Possible return values are represented by macros defined in
usertimers.h.:
USER_TIMER_OK - Successfully claimed or released timer
USER_TIMER_INVALID_TIMER - Timer number not present on
system
USER_TIMER_NOT_CLAIMED - Another application already has
claimed the timer so this application could not claim it
USER_TIMER_NOT_RUNNING - Timer not running
Portability
This function is specific to the RAC6182 hardware
See Also
UserTimerSet
UserTimerGetValue
This function gets the count of user timer. It is prototyped in
usertimers.h.
Syntax
#include
#include
DWORD UserTimerGetValue(DWORD TimerNumber, DWORD *Count)
Remarks
Requests the current countdown value of an active timer.