LoadSetting Function

Format

s = loadsetting(attribute ʃ,default_settingʅ);

Description

The loadsetting function, using the string expression attribute, retrieves a setting from an attribute-value pair, a setting that has been previously saved using the savesetting function. An optional string or numeric expression default_setting can be provided and will be returned if no value has been saved for the given attribute.

The file from which settings are retrieved can be modified by altering the CommonStore attribute of a PFF file. If an attribute does not exist in the specified file but does exist in the global settings database (shared by all CSPro applications), then that global attribute-value pair is used.

Return Value

The function returns a string containing the value associated with the attribute. If no value is associated with the attribute, then the function returns a blank string unless a default setting has been provided, in which case it returns the default setting.

Example

PROC GLOBAL

function OnChangeLanguage()
// save the selected language so that the change is persistent,
// being available the next time that the program is run
savesetting("Language", getlanguage());
end;

PROC MY_APPLICATION_FF

preproc

// set the language at the start of the program, defaulting to English
setlanguage(loadsetting("Language", "EN"));