Cicode Programming Reference > Cicode Function Categories > Equipment Database Functions > EquipCheckUpdate

EquipCheckUpdate

The runtime environment will automatically check if the equipment database has been updated before each page open and before running an equipment browse open function (EquipBrowseOpen). It does this by checking the version of the database file. You may also update the database periodically in a background task to reload the database even if the page is not changed.

The EquipCheckUpdate function checks if the equipment database file has been updated, and provides the facility to reload it. The reload can only be performed if there are no open browse sessions.

Syntax

INT EquipCheckUpdate(INT Reload[, STRING sCluster])

Reload:

Cluster:

The cluster name to check and/or reload the equipment database for. All clusters will be checked if omitted or an empty string is set.

Return Value

0 (FALSE) if the equipment database has not changed, or 1 (TRUE) if it has been changed, otherwise an error is returned.

Related Functions

EquipBrowseClose, EquipBrowseGetField, EquipBrowseFirst, EquipBrowseNext, EquipBrowseNumRecords, EquipBrowseOpen, EquipBrowsePrev, EquipGetProperty

See Also

Equipment Database Functions

Published June 2018