Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Examples
Tag Name
Expression
Tag GetOS() //Returned value = 2
GetPerformanceMetric
The GetPerformanceMetric function returns selected metrics for the graphics performance of your project
runtime client.
Function Group Execution Windows Embedded Web
GetPerformanceMetric System Info Synchronous Supported Supported Supported
Syntax
GetPerformanceMetric( numMetrictype, "optTagDescription" )
GetPerformanceMetric({ numMetrictype | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12
| 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30
| 31 }{ | ,"optTagDescription" })
numMetrictype
The type of performance metric to get, as shown in the table below:
Value of numMetrictype
Description, including the string that is written to optTagDescription
0 Memory Allocation Enabled
How the virtual memory is currently allocated to shared objects: 0 = Disabled; 1 = Always; 2 = Dynamic; 3 =
Critical.
Disabled
Always
Dynamic
Critical
1 Critical Free Memory Limit (KB)
The Enable memory allocation option (Project Settings > Options >
Performance Control) is not selected. Objects are loaded into memory
only when they are actually used, and then they are immediately removed
afterwards.
Objects are always kept in memory, in order to increase run-time
performance.
Objects are kept in memory until the memory is needed for new objects.
If enough memory is freed, then the memory allocation state may return
from Dynamic to Always.
All unused objects are cleared from memory and memory allocation
is disabled until the project is restarted. This is effectively the same as
Disabled (see above), except that the Enable memory allocation option
is still selected.
When the amount of free virtual memory (in KB) decreases to this limit, the memory allocation state is changed
from Dynamic to Critical.
This limit is set in Project Settings > Options > Performance Control.
2 Min Free Memory Limit (KB)
When the amount of free virtual memory (in KB) decreases to this limit, the memory allocation state is changed
from Always to Dynamic.
This limit is set in Project Settings > Options > Performance Control.
3 Free Memory (KB)
InduSoft Web Studio Page 665