Stg_get_num_members()

Top  Previous  Next

Description:

API procedure, returns the number of members for the specified setting.

Syntax:

function stg_get_num_members(byref stg_name_or_num as string, byref num_members as byte) 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.

In case of successful execution returns the number of members through the num_members argument.

See Also:

Working with Multi-value 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.

num_members

The number of members for this setting will be returned through this argument.

Details

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