IDataModelScriptDebug2 interface (dbgmodel.h)

An optional interface on scripts (objects which implement IDataModelScript). If this interface is supported, the script provider has a debug engine capable of some limited form of 'script debugging'. This may include stepping, setting breakpoints, inspecting data, etc...

This version 2 of the interface supports all of the previous methods with identical signatures and includes additional new methods that provide added functionality. The new methods are listed in the header at the end of the section for that interface.

Inheritance

IDataModelScriptDebug2 inherits from IDataModelScriptDebug.

Methods

The IDataModelScriptDebug2 interface has these methods.

 
IDataModelScriptDebug2::AddRef

The IDataModelScriptDebug2::AddRef method increments the reference count for an interface on an object.
IDataModelScriptDebug2::EnumerateBreakpoints

The IDataModelScriptDebug2::EnumerateBreakpoints method returns an enumerator capable of enumerating every breakpoint when a script debugger is enabled.
IDataModelScriptDebug2::FindBreakpointById

The FindBreakpointById method is used to get an interface to the breakpoint from a given identifier.
IDataModelScriptDebug2::GetCurrentPosition

The IDataModelScriptDebug2::GetCurrentPosition method returns the current break position in a script debugging session.
IDataModelScriptDebug2::GetDebugState

The GetDebugState method returns the current state of the script (that is whether it is executing or not).
IDataModelScriptDebug2::GetEventFilter

The IDataModelScriptDebug2::GetEventFilter method returns whether break-on-event is enabled for a particular event.
IDataModelScriptDebug2::GetStack

The IDataModelScriptDebug2::GetStack method gets the current call stack at the break position in a script debugger session.
IDataModelScriptDebug2::QueryInterface

The IDataModelScriptDebug2::QueryInterface method retrieves pointers to the supported interfaces on an object.
IDataModelScriptDebug2::Release

The IDataModelScriptDebug2::Release method decrements the reference count for an interface on an object.
IDataModelScriptDebug2::SetBreakpoint

The IDataModelScriptDebug2::SetBreakpoint method sets a breakpoint within a script when a script debugger is enabled.
IDataModelScriptDebug2::SetBreakpointAtFunction

Sets a breakpoint on the function given by the supplied name.
IDataModelScriptDebug2::SetEventFilter

The IDataModelScriptDebug2::SetEventFilter method changes the break-on-event behavior for a particular event.
IDataModelScriptDebug2::StartDebugging

The IDataModelScriptDebug2::StartDebugging method turns on the debugger for a particular script but does not begin execution break or stepping.
IDataModelScriptDebug2::StopDebugging

The IDataModelScriptDebug2::StopDebugging method stops debugging activity after the StartDebugging method was successfully called.

Remarks

The infrastructure for script providers in the data model also provides a concept around debugging scripts. Any script that wishes to expose debugging capabilities to the debug host and the debugger application hosting the data model can do so by having debuggable scripts implement the IDataModelScriptDebug interface in addition to the IDataModelScript interface. The presence of this interface on the script indicates to the infrastructure that it is debuggable.

Requirements

Requirement Value
Header dbgmodel.h

See also

Debugger Data Model C++ Overview