Stg_restore_member()

Top  Previous  Next

Description:

API procedure, initializes (sets the default value for) the specified setting's member.

Syntax:

function stg_restore_member(byref stg_name_or_num as string, index as byte) as en_stg_status_codes

Returns:

One of these en_stg_status_codes: EN_STG_STATUS_OK, EN_STG_STATUS_NOT_STARTED, EN_STG_STATUS_UNKNOWN,  EN_STG_STATUS_INVALID_INDEX, EN_STG_STATUS_FAILURE.

See Also:

Verifying and Initializing Settings

 


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.

index

Setting member.

stg_timestamp variable

When STG_TIMESTAMP is 1, this variable should be preset with the desired timestamp prior to calling stg_restore_member().

Details

Default values for setting members can be defined through the setting configurator.

The setting's member is restored regardless of the value of the initialization mode field in the descriptor file.

When this procedure executes, callback_stg_post_set() is called for the setting being initialized.