Stg_get_def()

Top  Previous  Next

Description:

API procedure, returns the default value for the specified setting's member.

Syntax:

function stg_get_def(byref stg_name_or_num as string, index as byte, byref def_value 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_UNKNOWN,  EN_STG_STATUS_INVALID_INDEX.

In case of successful execution returns the default value for the specified setting's member through the def_value argument.

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.

def_value

The default setting member's value will be returned through this argument.

Details

This function only accesses and reads the data from the configuration file.