Module Activity functions

These functions are used to manage a project’s various runtime modules — such as background tasks, the data server, and the project viewer — as well as those modules’ interactions with the operating system.

  • AppActivate
    AppActivate is a built-in scripting function that activates (i.e., brings to the front) another application window that is already open.
  • AppIsRunning
    AppIsRunning is a built-in scripting function that verifies another application window is open and running.
  • AppPostMessage
    AppPostMessage is a built-in scripting function that sends a Windows system message to another application window.
  • AppSendKeys
    Sends keyboard commands to the active application.
  • CleanReadQueue
    Removes all reading messages from the communications module.
  • CloseSplashWindow
    Closes the IWS splash screen.
  • DisableMath
    DisableMath is a built-in scripting function that pauses the execution of all Math worksheets.
  • EnableMath
    EnableMath is a built-in scripting function that resumes the execution of all Math worksheets.
  • EndTask
    The function EndTask stops a specified run-time module that is currently running.
  • ExitWindows
    Exits the Windows operating system in a specified manner.
  • IsScreenOpen
    The function IsScreenOpen that a project screen is open on a client.
  • IsTaskRunning
    Verifies that a background task is running.
  • IsViewerInFocus
    Verifies that the project viewer (Viewer.exe) is in focus on the display.
  • KeyPad
    Displays a Virtual Keyboard to prompt the runtime user to enter a tag value.
  • LogOff
    This function logs off the current user and then logs on the default user (typically “guest”).
  • LogOn
    This function either logs on a specified user or displays a Log On dialog.
  • Math
    Executes the specified Math worksheet.
  • PostKey
    The function PostKey posts virtual-key codes to the currently displayed project screen. In other words, it simulates keyboard input.
  • Recipe
    Executes the specified Recipe worksheet.
  • Report
    Executes the specified Report worksheet and sends the output to hard disk, printer, or PDF.
  • RunGlobalProcedureAsync
    This function executes a global procedure asynchronously, in its own thread, so that it does not slow down or interfere with other running scripts. The procedure is run on the project server, but it can be called by any local or remote client.
  • RunGlobalProcedureAsyncGetStatus
    This function gets the status of one or more global procedures that were run asynchronously by calling the RunGlobalProcedureAsync function. Each procedure is run in its own thread, so that it does not slow down or interfere with other threads.
  • RunGlobalProcedureOnFalse
    This function runs a global procedure when the value of a specified project tag or expression becomes FALSE.
  • RunGlobalProcedureOnServer
    The function RunGlobalProcedureOnServer runs a specified VBScript procedure, as defined in the Procedures folder in the Project Explorer. The procedure is run on the project runtime server, but it can be triggered by any client that calls this function.
  • RunGlobalProcedureOnTrigger
    This function runs a global procedure when the value or quality of a specified tag changes.
  • RunGlobalProcedureOnTrue
    This function runs a global procedure when the value of a specified project tag or expression becomes TRUE.
  • RunVBScript
    Executes a statement in VBScript language.
  • SecureViewerReload
    SecureViewerReload is a built-in scripting function that closes the Secure Viewer program and then reloads it with a new configuration file.
  • SendKeyObject
    The function SendKeyObject sends a key event code to objects in the currently displayed project screen. You can use this function to trigger Command animations on those objects.
  • SetAppPath
    Sets the new file path for the project folder. After this function is executed, IWS will look for all of the project files (i.e.,screens, alarms, trends, database, events) in this folder.
  • SetViewerInFocus
    SetViewerInFocus is a built-in scripting function that moves the project viewer in front of all other open windows and then maximizes it to fill the display.
  • SetViewerPos
    Sets the height, width, and position of the project viewer or thin client.
  • ShutDown
    This function stops all execution tasks and runtime modules, effectively shutting down the project.
  • StartTask
    The function StartTask starts a specified run-time module that is not currently running.
  • ViewerPostMessage
    The function ViewerPostMessage posts a Windows System Message to the specified project screen.
  • Wait
    Pauses the project for a specified number of milliseconds.
  • WinExec
    WinExec is a built-in scripting function that executes a Windows command as if it was entered at the command prompt.
  • WinExecIsRunning
    This function indicates whether a Windows program previously executed by the function WinExec is still running.
InduSoft Web Studio -Technical Reference

Module Activity functions