Stg_check_all()

Top  Previous  Next

Description:

API procedure, verifies each setting by reading its value through stg_sg().

Syntax:

function stg_check_all(byref problem_stg as string) 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_FAILURE, EN_STG_STATUS_INVALID

See Also:

Verifying and Initializing Settings

 


Part

Description

problem_stg

After the procedure execution will contain the name of the problem setting, if any. Will be NULL if no problems were encountered.

Details

Execution stops once any problem for any setting is encountered. Thus, only one problem is reported.