14 timer controls – Rice Lake iRite IDE User Manual

Page 77

Advertising
background image

920i

Programming Reference - API Reference

73

SysCode values returned:

SysNoSuchDatabase

The referenced database cannot be found.

SysNoSuchRecord

The requested record is not contained in the database.

SysOK

The function completed successfully.

<DB>.Sort

Sorts database <DB> into ascending order based on the contents of column I. The sort table supports a maximum
of 30 000 elements. Databases with more than 30 000 records cannot be sorted.

Method Signature:
function <DB>.Sort (I : Integer) : SysCode;

SysCode values returned:

SysNoSuchDatabase

The referenced database cannot be found.

SysNoSuchRecord

The requested record is not contained in the database.

SysOK

The function completed successfully.

<DB>.Update

Updates the current record in the referenced database with the contents of <DB>. Using this function invalidates
any previous sort operation.

Method Signature:
function <DB>.Update : SysCode;

SysCode values returned:

SysNoSuchDatabase

The referenced database cannot be found.

SysNoSuchRecord

The requested record is not contained in the database.

SysOK

The function completed successfully.

5.14 Timer Controls

Thirty-two timers, configurable as either continuous and one-shot timers, can be used to generate events at some
time in the future. The shortest interval for which a timer can be set is 10 ms.

ResetTimer

Resets the value of timer T (1–32) by stopping the timer, setting the timer mode to TimerOneShot, and setting the
timer time-out to 1.

Parameters:

[in]

T

Timer number

Method Signature:
function ResetTimer (T : Integer) : Syscode;

SysCode values returned:

SysInvalidTimer

The timer specified by

T

a not valid timer.

SysOK

The function completed successfully.

ResumeTimer

Restarts a stopped timer T (1–32) from its stopped value.

Method Signature:
function ResumeTimer (T : Integer) : Syscode;

Parameters:

[in]

T

Timer number

SysCode values returned:

SysInvalidTimer

The timer specified by

T

a not valid timer.

SysOK

The function completed successfully.

Advertising
This manual is related to the following products: