11.29 loadprofile()
This function reads in the values of the configurable record instances (.configurable = true) and global variables (declared with config) of a dialog or module from a configuration file (profile).
Definition
boolean loadprofile ( string Filename input { , object Module := null input } )
Parameters
- string Filename input
- This parameter defines the file name of the configuration file. A file path can be specified which may also contain an environment variable.
- object Module := null input
-
This optional parameter contains the identifier of the dialog or module whose record and variable values are to be read in from the file.
With Module = null, the module ID of the current rule is used.
Return value
- true
- Reading in the values from the configuration file has been successful.
- false
-
The values could not be read in.
This may be due to errors accessing the file or an invalid module ID.
Availability
See also
C