Rice Lake iRite IDE - Manual (Page 49)

Note
920i Programming Reference - API Reference 45
When using with Firmware 4.xx/iQube2: The IQSys and IQPlat data types will return SysOk as long as the
command is correctly formatted (i.e., scale exists). If you want to know whether the iQube2 is in an error
condition, look at the value (not the syscode) of the IQ2StatusLC data type.
Method Signature:
function GetIqubeData(port_no : integer; dataType : IQValType; index : integer;
data : real) : SysCode;
SysCode values returned:
SysOutOfRange The array index is less than or equal to 0.
SysInvalidRequest The requested port is not configured as an iQube; the value cannot be returned due
to the device configuration, i.e., trying to address load cell 17; certain requests
while the diagnostic screen is open; or an invalid data type is requested.
SysDeviceError The scale is reporting an internal error.
SysOK The function completed successfully.
GetKey
Waits for a key press from the indicator front panel before continuing the program. The optional time-out is
specified in 0.01-second intervals (1/100 seconds); if the wait time is set to zero, the procedure will wait
indefinitely.
Method Signature:
function GetKey (timeout : Integer) : Syscode;
Parameters:
[in] timeout Time-out value
Example:
this_key : Keys;
…
DisplayStatus ("Press [Enter] for Yes");
GetKey(0);
if this_key = EnterKey then
DisplayStatus ("Yes");
else
DisplayStatus ("No");
end if;
GetSoftwareVersion
Returns the current software version.
Method Signature:
function GetSoftwareVersion : String;
GetTime
Extracts time information from DT and places the data in variables Hour, Minute, and Second.
Method Signature:
procedure GetTime (DT : DateTime; VAR Hour : Integer; VAR Minute : Integer; VAR
Second : Integer);
Parameters:
[in] DT DateTime variable name
[out] Hour Hour
[out] Minute Minute
[out] Second Second
GetUID
Returns the current unit identifier.
Method Signature:
function GetUID : String;