Rockwell Automation 6182 SDK - Manual (Page 75)

RAC6182-Specific Extensions to the CE API 4–35
Publication 6182-UM002B-EN-P
Remarks
This function is used to claim or release exclusive access to a specific
timer. A timer must be claimed before any function taking a
TimerNumber as a parameter can be used. A timer must be released to
allow any other application to claim and use the timer.
Parameter Description
TimerNumber TimerNumber is 0 based (i.e. if 2 timers are present
on the system, they are timer #0 and timer #1).
Claim Claim is TRUE to claim access to a timer, FALSE to
release it.
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
claimed the timer so this application could not claim it
USER_TIMER_ALREADY_CLAIMED - This application has
already claimed this timer
Portability
This function is specific to the RAC6182 hardware.
See Also
UserTimerGetNumberOfTimers
UserTimerRequestFrequency
This function sets the frequency of user timers. It is prototyped in
usertimers.h.
Syntax
#include
#include
DWORD UserTimerRequestFrequency(DWORD TimerNumber,DWORD
*Frequency)
Remarks
Requests that the timer use a frequency as close as possible to a specified
frequency for its count. Hardware timer capabilities vary significantly, so
there may only be one or certain gradations of real frequencies possible.