Callback_stg_error()

Top  Previous  Next

Description:

Callback procedure, informs of the error during the execution of stg_get() or set_set(). Procedure body has to be created elsewhere in the project (externally with respect to the library).

Syntax:

sub callback_stg_error(byref stg_name_or_num as string, index as byte, status as en_stg_status_codes)

Returns:

---

See Also:

Using Stg_get() and Stg_set()

 


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 should be interpreted as the name of the setting. If the string starts with a digit, then this should 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.

status

One of the en_stg_status_codes codes indicating the type of the detected error.

Details

This procedure is invoked when the following procedures execute:

Stg_get()
Stg_set()

Notice that this procedure is never called during the execution of other procedures, even though many of them access settings!

 

The following procedures can't be called from within callback_stg_error() or recursion error will be generated by the compiler:

Stg_get()
Stg_set()