SetupSave()

Type: REGULAR FUNCTION

Purpose: Stores a selected group of experimental parameters in a disk file.

It is equivalent to a Setup() function in which the user chooses to save the current Setup() settings. The major differences are that in SetupSave() no dialog box is displayed and the user need not take any action to store the setup parameters.

In the Gamry Framework™ a file used to store experimental parameters can contain more than one set of parameters. Each set of parameters is stored in a separate section of the file. The sections are identified by a SetupName. In the ASCII Setup file, the SetupName that precedes each section is enclosed in square brackets (e.g., [Test 5] ). The value of each object stored in a section of the file is preceded by the object's Tag.

An object must have a dialog license to be used in SetupSave(). An error dialog box is displayed if you attempt to SetupSave() an invalid variable or object.

The Setup file may already have items stored in the SetupName section. If an item already stored in the file does not have the same Tag as an object being saved, that item is not changed. Old items with the same Tag as a new item are overwritten.

Usage: Status = SetupSave(FileName, SetupName, Item1, Item2, Item3, ....)

  FileName STRING Pathname to the Setup file.
  SetName STRING Name of the section in the Setup file.
  ItemN OBJECT Object of any class with a Dialog License.
  Status BOOL

TRUE if Setup file opened and field name is valid

FALSE if file cannot be opened or field name is invalid .

Related Topics Link IconRelated Topics