8.8.1.1.1. JavaScript API Reference

8.8.1.1.1.1. Functions

initScripting(options={})

Initialize the debugger process for scripting and returns a DebuggerScripting object.

// Initialize scripting with default options
ds = initScripting();

// Initialize scripting with debugger messages suppressed
// and a 10 second timeout
ds = initScripting({ suppressMessages: true, timeout: 10000 });
Parameters:
  • options -- Optional configuration options provided as a dictionary. The available options are:

Option

Type

Description

timeout

number

Initial timeout value in milliseconds. By default, there is no timeout.

ccsRoot

string

Absolute path to the root directory of the CCS installation. Only needed if package is relocated.

suppressMessages

boolean

Suppresses printing of debugger status and GEL message to the console. (default: false)

logFile

string

If provided, enables logging to the specified file. Should be an absolute path.

attach

number | "auto"

If provided, will attach to the active debugger with the provided handle. (Experimental: If "auto" is provided, will try to find the active debugger process.)

Return type:

DebuggerScripting

sleep(ms)

Blocks the main thread's event loop for the prescribed number of milliseconds.

// Resume CPU execution for 2 seconds
session.target.run(false);
sleep(2000);
session.target.halt();

8.8.1.1.1.2. Objects

8.8.1.1.1.3. Types