Stg_set_ts()

Top  Previous  Next

Description:

API procedure, writes (sets) the timestamp for the specified setting. Only available when STG_TIMESTAMP is 1.

Syntax:

function stg_set_ts(byref stg_name_or_num as string) as en_stg_status_codes

See Also:

Understanding Timestamps

 


Part

Description

stg_name_or_num

Setting name or number. If the supplied string does not start with a digit (0-9), then the string is interpreted as the name of the setting. If the string starts with a digit, then this will be interpreted as the setting number. Settings are numbered counting from 0, and in the order of their appearance in the setting configurator.

stg_timestamp variable

This global variable should be preset with the desired timestamp prior to calling stg_set_ts().

Details

This procedure allows to modify the timestamp of the setting without affecting the values of setting members.

New timestamp is also set for the setting also when one of the following procedures executes:

Stg_start() — for all settings whose Storage Location is Non-volatile.

Stg_restore_multiple() — for each setting being restored.

Stg_restore_member() — for the setting being restored.

Stg_set() — for the setting being written to.

Stg_sg() when op= 1- EN_STG_SET — for the setting being written to.