RunGlobalProcedureOnTrue

This function directly executes a VBScript procedure when the value of a specified tag/expression becomes TRUE.

Function Group Execution Windows Embedded Thin Client
RunGlobalProcedureOnTrue Tags Database Synchronous Supported Supported Supported

Syntax

RunGlobalProcedureOnTrue("strCondition",strProcedureOnTrue)
strCondition
A project tag or expression.
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.
strProcedureOnTrue
The name of the procedure (in the Procedures folder) to execute when the value of strCondition becomes TRUE (non-zero).

Returned value

This function returns the following possible values:
Value Description
0 Error
1 Success

Notes

Once this function is called, it remains active until the runtime project is stopped. That means every time the tag/expression becomes TRUE, the procedure is executed. However, the procedure is executed only once when the tag/expression becomes TRUE; it is not continuously executed while the tag/expression is TRUE.

The procedure is executed on the Client. To execute a procedure on the Server, use the RunGlobalProcedureOnServer function.

Examples

When the value of TagOnTrue becomes TRUE (non-zero), execute the procedure UsingOnTrue:
RunGlobalProcedureOnTrue( "TagOnTrue", "UsingOnTrue" )