savesetting Function

Format

b = savesetting(attribute, value);

Description

The savesetting function saves a setting as an attribute-value pair using the string expression attribute and the string or numeric expression value. You can save multiple settings using different attribute strings and can retrieve the settings using the loadsetting function. These settings are stored locally on the device and can be accessed by other programs using the attribute string. Using settings is a way to share data between different CSPro applications on the same device.

The file from which settings are retrieved can be modified by altering the CommonStore attribute of a PFF file.

All settings can be cleared using the following command: savesetting(clear);

Settings can also be set using the Settings.putValue action. The persistent variable modifier can also be used to serialize settings across application runs.

Return Value

The function returns 1 (true) if successful or 0 (false) if the function failed.

Example

PROC INTERVIEWER_NAME

preproc

string InterviewerNameKey = "InterviewerName";

INTERVIEWER_NAME = loadsetting(InterviewerNameKey);

postproc

if strip(INTERVIEWER_NAME) = "" then
errmsg("You must enter the interviewer's name.");
reenter;
endif;

savesetting(InterviewerNameKey, INTERVIEWER_NAME);