Rice Lake iRite IDE User Manual
Page 57

920i
Programming Reference - API Reference
53
Parameters:
[in]
S
P
Setpoint number
SysCode values returned:
SysInvalidSetpoint
The setpoint specified by
SP
does not exist.
SysBatchRunning
Setpoint
SP
cannot be enabled while a batch is running.
SysInvalidRequest
The setpoint specified by
SP
cannot be enabled or disabled.
SysOK
The function completed successfully.
Example:
EnableSP (4);
GetBatchingMode
Returns the current batching mode (BATCHNG parameter).
Method Signature:
function GetBatchingMode : BatchingMode;
BatchingMode values returned:
Off
Batching mode is off.
Auto
Batching mode is set to automatic.
Manual
Batching mode is set to manual.
GetBatchStatus
Sets S to the current batch status.
Method Signature:
function GetBatchStatus (VAR S : BatchStatus) : SysCode;
Parameters:
[out]
S
Batch status
BatchStatus values returned:
BatchComplete
The batch is complete.
BatchStopped
The batch is stopped.
BatchRunning
A batch routine is in progress.
BatchPaused
The batch is paused.
SysCode values returned:
SysInvalidRequest
The BATCHNG configuration parameter is set to OFF.
SysOK
The function completed successfully.
GetCurrentSP
Sets SP to the number of the current batch setpoint.
Method Signature:
function GetCurrentSP (VAR SP : Integer) : Syscode;
Parameters:
[out]
S
P
Setpoint number
SysCode values returned:
SysInvalidRequest
The BATCHNG configuration parameter is set to OFF.
SysBatchNotRunning
No batch routine is running.
SysOK
The function completed successfully.
Example:
CurrentSP : Integer;
…
GetCurrentSP (CurrentSP);
WriteLn (Port1, "Current setpoint is", CurrentSP);