| Description: | Gathers the sum of all of the properties files in this layer and all of its parents including the local workstation files. |
| Returns: | Dictionary (see comments) |
Usage:  |
Script Only. |
| Function Groups: | Configuration Management |
| Related to: | ReadINI | ReadConfiguration | ReadPropertiesFile |
| Format: |
Layer\ReadINIProperties(Result[, ExternalLock, SuppressOrphanedComments]); |
| Parameters: |
| Result |
|
Required. A pointer to a value that, when all files have been read, is set to the dictionary of structures described in the comments section. If this is already a valid dictionary and the FileName parameter is valid, the data for the single file will be updated in the dictionary. This feature allow the publisher calls to Notifiy to update the structures. |
| ExternalLock |
| Optional Boolean. Set to TRUE if you do not want to acquire and release the lock. Defaults to FALSE. |
| SuppressOrphanedComments |
| Optional Boolean. Set to TRUE to ignore "+PseudoProperty" - comments that are not associated with a property. Defaults to FALSE. |
| Optional. Any |
| Comments: | INIProperty Struct [
Name { Variable name in the settings file };
Value { Simple Value or an ordered array of Values if the variable occurs more than once in the section of the file };
Comment { Text comment if present in the file };
]
A simpler function, ReadPropertiesFile, is much more direct if the location of the setting to be read is known. |
