GetPlatformInfo
(VTScada Layer module. Obtain LayerRoot using the following script-only statement: )
LayerRoot = \System.GetLoadedAppInstance(GetGUID(0, \LocalGUID));
Description: | Gathers information about the current application and the workstation it is running on. |
Returns: | Numeric status indicator. (Platform information is returned in the parameter) |
Usage: | Script Only. |
Function Groups: | Configuration Management |
Related to: | Platform | WKStaInfo |
Format: | LayerRoot\GetPlatformInfo(&Info) |
Parameters: |
&Info |
Required. Pointer to a variable. The information gathered will be returned in a structure that this variable points to. |
Comments: |
This utility function makes use of WkStaInfo and Platform to gather relevant information about the application. The structure returned has the following format: INIFiles Struct [ FileName { file name and extension for the file }; OEM { TRUE if an OEM layer file }; Workstation { Name of the workstation or invalid if global }; Layer { Instance of application layer owning the file }; Dynamic { TRUE if a dynamic property }; Sections { Dictionary of sections, each element of which is an array of Property structures (see following) }; Changed { User sets to true if the file has been changed, initialized to false }; ] The property structures have the following format: 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 }; Hidden { TRUE if not shown in the Edit Properties GUI }; ] |
Examples:
If 1 NextState; [ LayerRoot = System.GetLoadedAppInstance(GetGUID(0, \LocalGUID)); LayerRoot\GetPlatformInfo(&Info); ... ]