Interface Breakpoints

Adds a breakpoint at the specified location. The location can be an address, a symbolic expression, or a source file and line number

Remarks

Will throw if breakpoint location cannot be resolved.

Example

// Adds a breakpoint at 0x2400
let id = session.breakpoints.add(0x2400n);

// Adds a breakpoint at symbol 'main'
let id = session.breakpoints.add("main");

// Adds a breakpoint at an offset from symbol 'main'
let id = session.breakpoints.add("main + 0x8");

// Adds a breakpoint at line 24 of main.c
let id = session.breakpoints.add("C:/my_project/source/main.c", 24);
// or if we know there is only one main.c
let id = session.breakpoints.add("main.c", 24);
Copy

Add a breakpoint based on properties that have been set in advance. A set of breakpoint properties can be created using createProperties

Example

const propsId = session.breakpoints.createProperties();
//
// Configure properties...
//
let id = session.breakpoint.addWithProperties( propsId );
Copy

Creates a new set of breakpoint properties. A breakpoint can later be created from this set of properties using addWithProperties. Only one breakpoint can be added with each set of properties. Properties must be configured before calling addWithProperties.

Remarks

Will throw if the breakpoint type is not valid

Example

let id = session.breakpoints.createProperties();
Copy

Get a detailed list of all breakpoint properties currently available in the specified set of properties. Configuring some properties can cause other properties to become available or become unavailable.

Example

let id = session.breakpoints.createProperties();
let properties = session.breakpoints.getDetailedProperties(id);

// print details of properties
for (const prop of properties) {
  console.log(`${prop.id}:`);
  console.log(`  type: ${prop.type}`);
  console.log(`  description: ${prop.description}`);
  console.log(`  value: ${prop.value}`);
  if (prop.allowedValues) {
    console.log(`  allowedValues: ${JSON.stringify(prop.allowedValues)}`);
  }
  if (prop.allowedRange) {
    console.log(`  allowedRange: [${prop.allowedRange.min}, ${prop.allowedRange.max}]`);
  }
  console.log("");
}
Copy

Get the value of a specific breakpoint property

Remarks

Will throw if the property does not exist

Example

// Get the value of the Skip Count property. This is an integral value
let skipCount = session.breakpoints.getProperty(id, "Debugger Response.Skip Count");

// Get the breakpoint's location
let location = session.breakpoints.getProperty(id, "Hardware Configuration.Location");
// location might be an integral value (e.g. 0x1000n)
// it might also be a string if the location is a symbolic expression (e.g. "main + 0x8") or
// a source-based location (e.g. "C:/my_project/Debug/my_project.out@C:/my_project/main.c, line 12")
Copy

Removes a breakpoint

Remarks

Will throw if the breakpoint does not exist

Example

// Adds and then removes a breakpoint
let id = session.breakpoints.add(0x2400n);
session.breakpoints.remove(id);
Copy

Removes all user created breakpoints

Example

session.breakpoint.removeAll();
Copy

Set the value of a specific breakpoint property. You can only configure properties before they are used to add a breakpoint.

Remarks

Will throw if the property does not exist, the provided value cannot be set on the property, or if a breakpoint has already been added with this set of properties.

Example

// Set the Skip Count property to 5
session.breakpoints.setProperty(id, "Debugger Response.Skip Count", 5);

// Set the location to a symbolic expression
session.breakpoints.setProperty(id, "Hardware Configuration.Location", "main + 0x8");
Copy

Set the value of a location property to a source file and line number

Remarks

Will throw if the property does not exist, is not a location property, or if a breakpoint has already been added with this set of properties.

Example

// Set the location property to line 24 of our project's main.c file
session.breakpoints.setPropertySourceLocation(id, "Hardware Configuration.Location", "C:/my_project/source/main.c", 24);
// or if we know there is only one main.c
session.breakpoints.setPropertySourceLocation(id, "Hardware Configuration.Location", "main.c", 24);
Copy