Externalmodulescanfunctimedurationsget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.31

ExternalModuleScanFuncTimeDurationsGet

Name
ExternalModuleScanFuncTimeDurationsGet – Gets the current and the maximum
scan executing time for an ExternalModule.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the module number (must >=1 and <= NbExternalModules): (-17)
- Here: NbExternalModules is the number of modules declared in the line
SharedLibraryModuleNames of system.ref
Description
An ExternalModule has a scan function that is called periodically by Newport
MotionKernel. This function gets the current and the maximum scan executing time for
an ExternalModule.
Prototype
int ExternalModuleScanFuncTimeDurationsGet(
int SocketID,
int ModuleNumber,
double *CurrentDuration,
double *MaximumDuration
)
Input parameters
SocketID
ModuleNumber
Output parameters
CurrentDuration
MaximumDuration
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -17: Parameter out of range or incorrect.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
int External module number
char * Current scan executing duration.
char * Maximum scan executing duration.
77
Programmer's Manual
EDH0373En1023 — 01/18