Rockwell Automation 6182 SDK - Manual (Page 77)

RAC6182-Specific Extensions to the CE API 4–37
Publication 6182-UM002B-EN-P
UserTimerSet
This function sets the count of user timer and start timing. It is
prototyped in usertimers.h.
Syntax
#include
#include
DWORD UserTimerSet(DWORD TimerNumber,DWORD Count)
Remarks
Sets the timer to a given countdown value and starts the timer. The
frequency of the count is the last frequency returned from
UserTimerRequestFrequency. The countdown stops at 0 and the timer is
triggered.
Any count in progress is aborted by this function.
Parameter Description
TimerNumber Number of a timer previously claimed.
Count Number of ticks before a timeout is triggered. The
range may vary depending on the hardware
implementation of the counter.
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_SET_FAILED - Unable to set timer
USER_TIMER_INVALID_PARAMETER - Invalid value
Portability
This function is specific to the RAC6182 hardware.