GetPerformanceMetric
- Last UpdatedOct 29, 2026
- 4 minute read
The GetPerformanceMetric function returns selected metrics for the graphics performance of your project runtime client.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
GetPerformanceMetric |
System Info |
Synchronous |
Yes |
Supported |
Supported |
Not supported |
Supported |
Not 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 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. Always Objects are always kept in memory, in order to increase runtime performance. Dynamic 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. Critical 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. |
|
1 |
Critical Free Memory Limit (KB) 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) The amount of free virtual memory, in kilobytes. |
|
4 |
Free Memory (%) The amount of free virtual memory, as a percentage of total virtual memory. |
|
5 |
Total Allocation Allowed The maximum number of total shared objects that can be allocated. |
|
6 |
Total Allocation Count The number of total shared objects that are currently allocated. |
|
7 |
Total Allocation (%) The percentage ( count / allowed ) of total shared objects that are allocated. |
|
8 |
Brush Allocation Allowed The maximum number of shared brush objects that can be allocated. |
|
9 |
Brush Allocation Count The number of shared brush objects that are currently allocated. |
|
10 |
Brush Allocation (%) The percentage ( count / allowed ) of shared brush objects that are allocated. |
|
11 |
Brush Allocation State How the memory for shared brush objects is currently allocated: 0 = Disabled; 1 = Always; 2 = Dynamic; 3 = Critical. |
|
12 |
Font Allocation Allowed The maximum number of shared font objects that can be allocated. |
|
13 |
Font Allocation Count The number of shared font objects that are currently allocated. |
|
14 |
Font Allocation (%) The percentage ( count / allowed ) of shared font objects that are allocated. |
|
15 |
Font Allocation State How the memory for shared font objects is currently allocated: 0 = Disabled; 1 = Always; 2 = Dynamic; 3 = Critical. |
|
16 |
Pen Allocation Allowed The maximum number of shared pen objects that can be allocated. |
|
17 |
Pen Allocation Count The number of shared pen objects that are currently allocated. |
|
18 |
Pen Allocation (%) The percentage ( count / allowed ) of shared pen objects that are allocated. |
|
19 |
Pen Allocation State How the memory for shared pen objects is currently allocated: 0 = Disabled; 1 = Always; 2 = Dynamic; 3 = Critical. |
|
20 |
Bitmap Allocation (%) The percentage ( count / allowed ) of shared bitmap objects that are allocated. |
|
21 |
Bitmap Allocation Count The number of shared bitmap objects that are currently allocated. |
|
22 |
Bitmap Allocation Allowed The maximum number of shared bitmap objects that can be allocated. |
|
23 |
Bitmap Allocation State How the memory for shared bitmap objects is currently allocated: 0 = Disabled; 1 = Always; 2 = Dynamic; 3 = Critical. |
|
24 |
Image Allocation Allowed The maximum number of shared image objects that can be allocated. |
|
25 |
Image Allocation Count The number of shared image objects that are currently allocated. |
|
26 |
Image Allocation (%) The percentage ( count / allowed ) of shared image objects that are allocated. |
|
27 |
Image Allocation State How the memory for shared image objects is currently allocated: 0 = Disabled; 1 = Always; 2 = Dynamic; 3 = Critical. |
|
28 |
Buffer Allocation Allowed The maximum number of shared buffer objects that can be allocated. |
|
29 |
Buffer Allocation Count The number of shared buffer objects that are currently allocated. |
|
30 |
Buffer Allocation (%) The percentage ( count / allowed ) of shared buffer objects that are allocated. |
|
31 |
Buffer Allocation State How the memory for shared buffer objects is currently allocated: 0 = Disabled; 1 = Always; 2 = Dynamic; 3 = Critical. |
optTagDescription
The name of a String tag that will receive a description of the selected metric. The description is the same as shown in the table for numMetrictype above.
Note: If this parameter is enclosed in quotes, the string literal will be used. Otherwise, the value of the tag/expression will be used.
This parameter is optional.
Returned value
If this function is successfully executed, then it returns a positive value according to the type of metric that was selected (see numMetrictype above). Otherwise, if it was not successfully executed, then it returns a negative error value:
|
Returned value |
Description |
|---|---|
|
-1 |
Invalid number of parameters. |
|
-2 |
Wrong parameter type. |
|
-3 |
Could not get the selected metric. |
|
-4 |
Tag specified by optTagDescription does not exist. |
|
-5 |
Could not write to tag specified by optTagDescription. |
Notes
For more information about memory allocation, see Configure the performance control settings.