How to read function descriptions
This is a key to reading the descriptions of the built-in scripting functions.
Each function description is broken into several sections.
Function attributes
| Function | Group | Execution | Windows | Embedded | Thin Client | Mobile Access |
|---|---|---|---|---|---|---|
| function name | group name | synchronous or asynchronous | supported or not supported | supported or not supported | supported or not supported | supported or not supported |
First, obviously, the exact name of the function as it should be used in your project.
Next, the functions are organized into groups according to the type of calculcation they perform or the part of your project upon which they act. You can use the group names to find the functions you want in the Object Finder and in this documentation.
- Synchronous
- When the function is executed on either the project server or the project client, that station requires some response or acknowledgement from the other. The project pauses, however briefly, while it waits for the response. In other words, the server and client must remain synchronized.
This is normally not an issue because most functions are executed almost instantly, but if a client makes unusually frequent function calls or your network is slow, your project may suffer decreased performance.
- Asynchronous
- The function can be executed on either the project server or the project client without waiting for the other. The project continues to run without interruption.
- Windows
- The full InduSoft Web Studio software running as a project runtime server on Windows or Windows Server.
- Embedded
- Either EmbeddedView running on Windows Embedded Standard or CEView running on Windows Embedded Compact.
- Thin Client
- Either Secure Viewer (a.k.a. the InduSoft Thin Client software) or Web Thin Client (i.e., the ISSymbol plug-in for Internet Explorer).
- Mobile Access
- Project screens viewed in the browser via the Mobile Access web interface.
For more information about these system types, see About target platforms and product types.
Syntax diagram and parameters
A basic syntax diagram shows how the function should be entered and what parameters it takes.
- bool
- The parameter can take either a literal Boolean value or the name of a Boolean tag. For example, either 0 or MyBoolTag.
- num
- The parameter can take either a literal numerical value or the name of an Integer or Real tag. For example, either 45.6543 or MyNumTag.
- str
- The parameter can take either a text string enclosed in quotation marks or the name of a String tag. For example, either "My string" or MyStrTag.
The additional prefix opt indicates that a parameter is optional. If you do not specify a value for the parameter, the function will take the default value mentioned in the parameter description.
In the few cases where a parameter must take a project tag or some other special input, it will be fully explained in the parameter description.
Returned value
This section describes the value returned by the function, if any.
Some functions return a calculated value, depending on the nature of the function.
Other functions return an error code that indicates how well the function was executed. The possible codes and their meanings are provided in a table.
Notes
This section describes any additional notes or cautions on the use of the function.
Examples
This section shows how the function can be called in your project. Multiple examples are provided to show how the function can take both literal values and project tags, as well as how the function may be called if it has optional parameters.