Newport XPS-D - Timerget

XPS Unified Programmer’s Manual
7.2.1.329 TimerGet
Name
TimerGet – Gets the number of frequency ticks for the selected timer.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
Description
This function returns the number of frequency ticks configured for the selected timer.
The “TimerName” can be defined as:
• Timer1
• Timer2
• Timer3
• Timer4
• Timer5
The “FrequencyTicks” defines the frequency of the timer:
One frequency tick represents a corrector period = >0.125 ms = >8 khz
N frequency ticks represents N corrector periods = >N * 0.125 ms = > kHz
NOTE
“FrequencyTicks” = 0 means that the timer is disabled.
Prototype
int TimerGet(
int SocketID,
char * TimerName,
int * FrequencyTicks
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
TimerName char * Name of timer.
Output parameters
FrequecyTicks int * Number of frequency ticks.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
EDH0373En1023 — 01/18 478