Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Value of numMetrictype
Description, including the string that is written to optTagDescription
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: The tag name must be enclosed in quotes, as shown in the syntax
diagram, or else the project will try to get the value of the named tag.
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.
InduSoft Web Studio Page 667