VWorks-defined functions

Function descriptions

The VWorks JavaScript interpreter supports the JavaScript 1.5 or later core functions and objects. VWorks also has its own functions and objects that can be used.

The following VWorks-defined functions are available globally, so they are not restricted to a particular object or programming context.

 

Function	Description
GetGlobalObject()	Provides the ability to get the global context from a JavaScript that is executed in a context other than the global context. Returns an object that has all the variables of the global context. For example, in a protocol that uses the local context for variables, you can have a JavaScript task that includes a variable in the global context. Example: //(0) Create a reference to global object from this context. var g_ref = GetGlobalObject(); //(1) Declare a var xx in GlobalObject. g_ref.xx = 4 //(2) Increment the variable. g_ref.xx++ //(3) Print the variable. print(g_ref.xx) Note: In this example, lines (2) and (3) could be executing from different protocols, each in their own private context, with shared data results. Note: You can set a breakpoint on the task that uses this function to open the Debugger dialog box and view the variable (g_ref). For details on setting breakpoints, see Using breakpoints to monitor and troubleshoot tasks.
open()	Opens a text file and immediately executes the file contents as script. Parameter: Text string Examples: open("c:\\VWorks workspace\\script.js") open("c:\\VWorks workspace\\script.txt") Make sure the file is in ANSI text format. The file extension is not important. Note: Microsoft Notepad saves in ANSI text format by default.
print()	Prints time-stamped messages to the VWorks log. Parameter: Text string Example: print(plate.name)
run()	Runs a Microsoft Windows script as though it is being called from a command line. Parameters: • Text string. Required. Allows you to initiate a command that you could otherwise enter into the Windows Run dialog box, such as notepad text.txt (opens a file named text.txt in Windows Notepad). • Boolean True/False. Optional. Default is False. If True, the software waits for the function to complete before continuing (blocking). Examples: • run("notepad") • run("notepad",true) The first example starts Notepad. The second example starts Notepad and pauses the VWorks software until you exit Notepad.

Related information

 

For information about...	See...
Using JavaScript in the VWorks software	Using JavaScript
VWorks-defined plate objects, properties, and methods	plate object
VWorks-defined task objects, properties, and methods	task object
Using JavaScript utilities	Using JavaScript utilities
JavaScript task	JavaScript
Startup and cleanup protocols	Setting up Startup and Cleanup Protocol processes
Using script variables directly in task parameters	Using simple variables
How to specify the JavaScript context for a protocol	Setting protocol options
JavaScript context and form design	Understanding JavaScript context in form design