Rice Lake iRite IDE User Manual
Page 61

920i
Programming Reference - API Reference
57
Example:
SP4Val : Real;
…
GetSPValue (4, SP4Val);
WriteLn (Port1, "Current Value of SP4 is", SP4Val);
GetSPVover
For checkweigh (CHKWEI) setpoints, sets V to the current overrange value (VOVER parameter) of the setpoint
SP
.
Method Signature:
function GetSPVover (SP : Integer; VAR V : Real) : SysCode;
Parameters:
[in]
S
P
Setpoint number
[out]
V
Overrange value
SysCode values returned:
SysInvalidSetpoint
The setpoint specified by
SP
does not exist.
SysInvalidRequest
The setpoint specified by
SP
has no VOVER parameter.
SysOK
The function completed successfully.
Example:
SP3VOR : Real;
…
GetSPVover (3, SP3VOR);
WriteLn (Port1, "Current Overrange Value of SP3 is", SP3VOR);
GetSPVunder
For checkweigh (CHKWEI) setpoints, sets V to the current underrange value (VUNDER parameter) of the
setpoint SP.
Method Signature:
function GetSPVunder (SP : Integer; VAR V : Real) : SysCode;
Parameters:
[in]
S
P
Setpoint number
[out]
V
Underrange value
SysCode values returned:
SysInvalidSetpoint
The setpoint specified by
SP
does not exist.
SysInvalidRequest
The setpoint specified by
SP
has no VUNDER parameter.
SysOK
The function completed successfully.
Example:
SP4VUR : Real;
…
GetSPVunder (4, SP4VUR);
WriteLn (Port1, "Current Underrange Value of SP4 is", SP4VUR);
PauseBatch
Initiates a latched pause of a running batch process.
Method Signature:
function PauseBatch : SysCode;
SysCode values returned:
SysPermissionDenied
The BATCHNG configuration parameter is set to OFF.
SysBatchRunning
No batch routine is running.
SysOK
The function completed successfully.