Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
• If the function was called with no parameters…
RunGlobalProcedureAsyncGetStatus( )
…then the returned value is the total number of threads that are currently running.
• If the function was called with only the optNumThreadID parameter…
RunGlobalProcedureAsyncGetStatus( optNumThreadID )
…then the returned value is either 0, indicating that the thread is still running, or the value that was
returned by the procedure.
• If the function was called with the Array tags…
RunGlobalProcedureAsyncGetStatus( "optTagThreadIDs", "optTagStatus",
"optTagParameters" )
…then the tags will receive the appropriate values for all currently running and recently completed
threads.
If the function fails, then it returns one of the following errors:
Value
Description
-1 Function is not supported on Viewer / Web Thin Client.
-2 Invalid thread ID.
-3 Invalid optTagThreadIDs.
-4 Invalid optTagStatus.
-5 Invalid optTagParameters.
-100 Internal error. Please contact technical support.
Notes
It is very important to note that this function can only be called by background tasks (e.g., Math, Script,
Scheduler) on the project server. It cannot be directly called from any project client, even if the project client
is running on the same workstation or device as the project server, because the client process is singlethreaded.
To indirectly call the function from a project client, configure a Math or Script worksheet to execute
on a tag/expression trigger, and then configure a project screen to activate the trigger when needed. For
example, configure the worksheet to execute when the value of MyTag is 1, and then configure a Button
screen object to toggle the value of MyTag when pressed.
Also, when the call to RunGlobalProcedureAsync succeeds, it returns an ID for the thread created and starts
running the procedure in that thread. The status of the thread is stored in an internal buffer and can be
retrieved using the RunGlobalProcedureAsyncGetStatus function. The buffer gets cleared when:
• The RunGlobalProcedureAsyncGetStatus function has been called and the thread status is different
from 0 (thread is running); or
• The maximum buffer size has been exceeded, the thread is no longer running, and a call to start a new
thread has been made.
RunGlobalProcedureOnFalse
This function directly executes a global procedure when the value of a specified tag/expression becomes
FALSE.
Function Group Execution Windows Embedded Thin Client
RunGlobalProcedureOnFalse
Module Activity Synchronous Supported Supported Supported
Page 612
InduSoft Web Studio