Stg_find()

Top  Previous  Next

Description:

API procedure, returns the number of the specified setting.

Syntax:

function stg_find(byref stg_name_or_num as string) as byte

Returns:

0 if the specified setting wasn't found, or

setting number +1 if the setting was found. Settings are numbered counting from 0, and in the order of their appearance in the setting configurator.

See Also:

 

 


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.

Details

If stg_name_or_num argument starts with the digit, this function will simply return the setting number +1, but only if the setting with the specified number does exist (zero will be returned if it doesn't).