Rockwell Automation 2711P Software Development Kit User Manual - Manual (Page 57)

Publication 2711P-UM005A-EN-P - March 2007
PanelView Plus CE-Specific Extensions to the WinCE API 57
Requirements:
UserTimerStop
This function stops a claimed timer.
DWORD UserTimerStop (DWORD dwTimerNumber);
Parameters:
dwTimerNumber
The Timer Number is 0 based; i.e., if 2 timers are present on the
system, they are timer 0 and timer 1. When specifying a critical timer,
the flag USERTIMER_CRITICAL must be or’d with the Timer Number.
The range is 0 to MAX_TIMER_NUMBER.
Return Values:
Remarks:
Stops an active countdown in the timer specified by dwTimerNumber
Portability:
This function is specific to the PanelView Plus CE or the RAC6182.
Runs On Version Defined In Link To
PanelView Plus CE
RAC6182
All usertimers.h usertimers.lib
UserTImerStop - Return Codes
Value Description
USER_TIMER_OK The timer was running and was stopped.
USER_TIMER_INVALID_TIMER The timer number is not valid for the system.
USER_TIMER_NOT_CLAIMED This application has not claimed this timer.
USER_TIMER_NOT_RUNNING The timer was not running.