Stg_start()

Top  Previous  Next

Description:

API procedure, starts the STG library, parses the descriptor file, restores all volatile (RAM) settings to default values by calling stg_restore_multiple(EN_STG_INIT_MODE_RAM_ONLY)

Syntax:

function stg_start() as en_stg_status_codes

Returns:

One of these en_stg_status_codes: EN_STG_STATUS_OK, EN_STG_STATUS_OUT_OF_FILE_NUMBERS, EN_STG_STATUS_WRONG_DEFINE, EN_STG_STATUS_WRONG_DESCRIPTOR, EN_STG_STATUS_FAILURE

See Also:

Getting Started

 

Details

MUST be called first, before any other procedure in this library is invoked, or EN_STG_STATUS_NOT_STARTED will be returned by every other procedure you call.

When this procedure executes, callback_stg_post_set() is called for each setting whose Storage Location is Non-volatile. See Editing Settings for details.