Gemtree Software, Configuration, Full Html Context Help of The Peter System

This group of elements serves for saving program configuration in configuration INI file or in Windows registers. Configuration INI file allows storing program settings in separate configuration file (INI filename extension typically). Such files can exist more than one and thus can be easily run one program in more variants, e.g. for more users (used configuration file is determined by initial folder when running a program). Conversely Windows registers enable storing program parameters independently on place from which it is run, without necessity of creating separate configuration file.

The configuration file element determines INI filename which is used to store program configuration. As default a filename derived from program name is used, to which INI file extension is added and whose path leads into initial folder when program is started. If path is not adduced then this file is placed in Windows folder preferentially (not in current folder).

Single parameters are split into named sections in the configuration file. Main is preset as a default section name. If a section name is set to the empty text then element for reading text parameter returns multiline list of all sections in the configuration file.

The parameter name element determines name on single parameter which will be read or into which will be written. Config is preset as a default parameter name. If a parameter name is set to the empty text then element for reading text parameter returns multiline list of all parameters in section determined by previous element of parameter section. If a parameter name is empty when writing into text or numerical parameter then deleting the whole of the parameter section occurs.

The elements allow read or write into parameter with appointed name in appointed section. By reading elements a preset data can be appended as a parameter of the element which will be returned in a case when requested parameter will not be found. If the elements are used as a command without joined parameters then deleting of the appropriate parameter occurs. If empty text is set as a parameter name when reading text parameter then multiline list of names of all parameters in given section is returned. If empty text is set as a section name when reading text parameter then mulitline list of names of all sections is returned. If empty name of parameter is set when writing into text of numeric parameter then deleting of the whole section of parameters occurs.

The key group element determines group of key in the Windows registers, in which following operation with registers will be performed. Following numbers of register key groups are allowed:

1 = HKEY_CURRENT_USER group of keys is preset as a default. This group of keys is determined to keep configuration parameters for current user. Other commonly used key group is 2 = HKEY_LOCAL_MACHINE which serves to keep configuration parameters independently on the current user. Remaining groups of keys should not be ordinarily used by the program.

The key name element determines access path to the used key, that is group of program parameters. This path has form as a usual path to a folder on the disk without initial and ending back slash character \. A path Software\ with added program name (without file extension) is used as a default. To display structure of Windows registers one can use system program RegEdit (it can be found in the Windows folder).

The elements allow read or write into entry with appointed name in appointed key. By reading elements a preset data can be appended as a parameter of the element which will be returned in a case when requested entry will not be found. If the elements are used as a command without joined parameters then deleting of the appropriate entry occurs.