Rice Lake iRite IDE - Manual (Page 63)

920i Programming Reference - API Reference 59
SysCode values returned:
SysInvalidSetpoint The setpoint number specified by SP is less than 1 or greater than 100.
SysInvalidRequest The specified setpoint is not a DINCNT setpoint.
SysOK The function completed successfully.
SetSPDuration
For time of day (TOD) setpoints, sets the trip duration (DURATION parameter) of setpoint SP to the value
specified by DT.
Method Signature:
function SetSPDuration (SP : Integer; DT : DateTime) : SysCode;
Parameters:
[in] S P Setpoint number
[in] DT Setpoint trip duration
SysCode values returned:
SysInvalidSetpoint The setpoint specified by SP does not exist.
SysInvalidRequest The setpoint specified by SP has no DURATION parameter.
SysBatchRunning The value cannot be changed because a batch process is currently running.
SysOutOfRange The value specified for DT is not in the allowed range for setpoint SP .
SysOK The function completed successfully.
Example:
SP3DUR : DateTime;
…
SP3DUR := 00:3:15
SetSPDuration (3, SP3DUR);
SetSPHyster
Sets the hysteresis value (HYSTER parameter) of setpoint SP to the value specified by V.
Method Signature:
function SetSPHyster (SP : Integer; V : Real) : SysCode;
Parameters:
[in] S P Setpoint number
[in] V Hysteresis value
SysCode values returned:
SysInvalidSetpoint The setpoint specified by SP does not exist.
SysInvalidRequest The setpoint specified by SP has no hysteresis (HYSTER) parameter.
SysBatchRunning The value cannot be changed because a batch process is currently running.
SysOK The function completed successfully.
Example:
SP5Hyster : Real;
…
SP5Hyster := 15.0;
SetSPHyster (5, SP5Hyster);
SetSPNSample
For averaging (AVG) setpoints, sets the number of samples (NSAMPLE parameter) of setpoint SP to the value
specified by N.
Method Signature:
function SetSPNSample (SP : Integer; N : Integer) : SysCode;
Parameters:
[in] S P Setpoint number
[in] N Sample value