dnSpy.Contracts.Debugger

Hooked function. The owner can write their own code by calling

Gets the next address that will write to

Gets the address of the new hooked function. The first written byte will be written to this location. The original function is patched to jump to this address.

Gets the address of the original function after it has been moved. This address can be used to call the original function from the new code.

Gets the address of the function, which has been hooked by us. If you must call the real function from the new code, call and not this address.

Writes the next byte to the code section

Byte to write

Finds exported functions in native dlls

Gets a function

DLL name including the dll extension Name of function

Creates a hooked function

DLL name including the dll extension Name of function Address of function

Gets the address of a module

DLL name including the dll extension Start address of module End address of module (exclusive)

Gets the address of a function

DLL name including the dll extension Name of function Address of function

Context used by a

Gets the process

Finds exported functions in loaded native modules in the target process

Hooks native functions when the debugged process starts. Use to export an instance.

Returns true if it's enabled

Context

Hooks the function

Context Updated with an error message if it failed or null if it was successful

Metadata

See

See

See

See

See

Exports a instance

Constructor

DLL name including dll extension, case sensitive. It can be any name, it's only used to make sure only one handler patches a function. Function name, case sensitive. It can be any name, it's only used to make sure only one handler patches a function. Supported architecture Supported operating system Order

Constructor

DLL name including dll extension, case sensitive. It can be any name, it's only used to make sure only one handler patches a function. Function name, case sensitive. It can be any name, it's only used to make sure only one handler patches a function. Supported architectures or empty to support all available architectures Supported operating systems or empty to support all operating systems Order

DLL name including dll extension, case sensitive. It can be any name, it's only used to make sure only one handler patches a function.

Function name, case sensitive. It can be any name, it's only used to make sure only one handler patches a function.

Supported architectures or empty to support all available architectures

Supported operating systems or empty to support all operating systems

Gets the order

Attach to program base class. Created eg. by

Copies this instance to and returns it

Destination

A process that can be attached to

Process id

Runtime id

Gets the runtime GUID, see

Gets the runtime kind GUID, see

Runtime name, eg. "CLR v4.0.30319"

Short process name (filename)

Process title

Full filename

Processor architecture

Operating system

Gets all options required to attach to the process

Attaches to the process

Returns all processes that the debug engines support

Gets all programs that can be attached to

Cancellation token

Gets all programs that can be attached to

Process name. If it's empty or null, it matches any string. This can include wildcards (* and ?). Cancellation token

Gets all programs that can be attached to

Process names or null/empty to match any process name. The process name can include wildcards (* and ?) names, see Cancellation token

Gets all programs that can be attached to

Process names or null/empty to match any process name. The process name can include wildcards (* and ?) Process ids or null/empty to match any process id names or null, see Cancellation token

Options shown in the 'attach to process' dialog box and created by

Process id

Runtime id

Gets the runtime GUID, see

Gets the runtime kind GUID, see

Runtime name, eg. "CLR v4.0.30319"

Short process name (filename) or null to use the default value

Process title or null to use the default value

Full filename or null to use the default value

Command line or null to use the default value

Processor architecture or null to use the default value

Operating system or null to use the default value

Gets all options required to attach to the process

Creates

Creates new instances. This method is called on a background thread.

Context

Context passed to

Cancellation token

All valid process ids or empty if any process id is valid

Checks if it's a valid process. May be null.

Constructor

Cancellation token

Constructor

All valid process ids or null/empty if any process id is valid Checks if it's a valid process. May be null. Cancellation token

Creates instances. Use to export an instance.

Creates a new or returns null

true if all factories are called, false if only some of them get called

Metadata

See

Exports an instance

Constructor

Name, see

Name, see

Shows the Attach to Process dialog box

Shows the dialog box and returns the selected processes or an empty list

Options or null to use the default options

Shows the dialog box and attaches to the selected processes

Options or null to use the default options

Attach to Process dialog options

Gets the title or null to use the default title

Type of processes that can be attached to. Shown in the title bar, eg. "Unity" or null to not show anything

Text shown at the bottom of the dialog box between the buttons or null to use the default value

names, see or null to check every provider

Link button info shown next to the OK button

Link info

Tooltip message

URL to go to when button is clicked

Predefined names

.NET Framework

.NET

Unity Editor

Unity Player

A bound breakpoint. These only exist while debugging a program. A bound breakpoint is only created if the breakpoint is enabled.

Raised when a property is changed

Gets the breakpoint

Gets the process

Gets the runtime

Gets the module or null if none

Gets the address of the breakpoint. This property is valid if is true

true if is a valid address

Gets the warning/error message

Bound breakpoint message severity

No error/warning message

Warning

Error

Bound breakpoint message

No error/warning message

Gets the severity

Gets the message

Constructor

Severity Message

Compares this instance to

Other instance

Compares this instance to

Object

Gets the hash code

ToString()

Formats some columns in the code breakpoints window

Name of the Name property

Name of the Module property

Raised when a property is changed

Called when the name needs to be reformatted

Called when the module needs to be reformatted

Writes the name shown in the Name column

Output Options

Writes the module shown in the Module column

Output

Called when this instance isn't needed anymore

Formatter options

No bit is set

Show metadata tokens

Show module names

Show parameter types

Show parameter names

Show declaring types

Show return types

Show namespaces

Show intrinsic type keywords (eg. int instead of Int32)

Use digit separators

Use decimal instead of hexadecimal

Creates formatters. Use to export an instance.

Returns a formatter or null

Breakpoint location

Metadata

See

Exports a instance

Constructor

Type (compared against ), see

Constructor

Types (compared against ), see

Types (compared against ), see

Code breakpoint

Gets the unique code breakpoint id

Can be used by code to add custom hit test conditions

Raised when the breakpoint is hit and the process will be paused

Gets the breakpoint options

true if it's a temporary breakpoint that gets removed when all debugged processes have exited

true if it's a hidden breakpoint. It's not shown in the UI (eg. breakpoints window, call stack window, glyph margin, text view)

true if it's a one-shot breakpoint. When the breakpoint is hit, the process is paused and the breakpoint is removed

Gets/sets the current settings

true if the breakpoint is enabled

Condition

Hit count

Filter

Trace message

Labels

Gets the breakpoint location

Gets all bound breakpoints

Raised when is changed

Gets the bound breakpoints warning/error message

Raised when is changed

Removes the breakpoint

Breakpoint hit check event args

If false, it doesn't count as a hit and the process is not paused. If true, the normal BP settings decide if the process gets paused. The default value is true.

Gets the bound breakpoint

Gets the thread

Constructor

Bound breakpoint Thread

Breakpoint hit event args

Gets the bound breakpoint

Gets the thread

Constructor

Bound breakpoint Thread

Code breakpoint display settings

Raised when a property is changed

Raises

Name of property that got changed

Show metadata tokens

Show module names

Show parameter types

Show parameter names

Show declaring types

Show return types

Show namespaces

Show intrinsic type keywords (eg. int instead of Int32)

Breakpoint hit count service

Raised when the hit count is updated

Gets the hit count or null if we're not debugging

Breakpoint

Resets the hit count

Breakpoint

Resets the hit count

Breakpoints

Breakpoint and hit count

Gets the breakpoint

Gets the current hit count. It's null if we're not debugging

Constructor

Breakpoint Current hit count or null if we're not debugging

event args

Gets breakpoints and hit counts

Constructor

Breakpoints and hit counts

options

No bit is set

It's a temporary breakpoint that gets removed when all debugged processes have exited

It's a hidden breakpoint. It's not shown in the UI (eg. breakpoints window, call stack window, glyph margin, text view)

It's a one-shot breakpoint. When the breakpoint is hit, the process is paused and the breakpoint is removed

Code breakpoint settings

true if the breakpoint is enabled

Condition

Hit count

Filter

Trace message

Labels

Compares this instance to

Other instance

Compares this instance to

Other instance

Gets the hash code

Code breakpoint condition kind

Condition is true

Condition is changed

Code breakpoint condition

Condition kind

Condition expression

Constructor

Condition kind Condition expression

Compares this instance to

Other instance

Compares this instance to

Other instance

Gets the hash code

ToString()

Hit count kind

Hit count == value

(Hit count % value) == 0

Hit count >= value

Hit count

Hit count kind

Hit count

Constructor

Hit count kind Hit count

Compares this instance to

Other instance

Compares this instance to

Other instance

Gets the hash code

ToString()

Code breakpoint filter

Filter

Constructor

Filter

Compares this instance to

Other instance

Compares this instance to

Other instance

Gets the hash code

ToString()

Code breakpoint trace message

Message

true to continue execution (trace) or false to break (breakpoint)

Constructor

Message true to continue execution (tracepoint) or false to break (breakpoint)

Compares this instance to

Other instance

Compares this instance to

Other instance

Gets the hash code

ToString()

Code breakpoints service

Modifies a breakpoint

Breakpoint New settings

Modifies breakpoints

New settings

Raised when breakpoints are modified

Gets all breakpoints

Gets all visible breakpoints

Raised when is changed

Adds a breakpoint. If the breakpoint already exists, null is returned.

Breakpoint info

Adds breakpoints. Duplicate breakpoints are ignored.

Breakpoints

Removes a breakpoint

Breakpoint to remove

Removes breakpoints

Breakpoints to remove

Returns an existing breakpoint at or null if none exists

Location

Removes all visible breakpoints

Raised when is changed

changed event args

Gets all breakpoints

Constructor

Breakpoints

Breakpoint and old settings

Gets the breakpoint

Gets the old settings

Constructor

Breakpoint Old settings

Breakpoints modified event args

Gets the breakpoints

Constructor

Breakpoints and old settings

Breakpoint and settings

Gets the breakpoint

Gets the new settings

Constructor

Breakpoint New settings

Info needed to add a breakpoint

Breakpoint location

Breakpoint settings

Breakpoint options

Constructor

Breakpoint location. If you don't own this location instance, you must call Breakpoint settings

Constructor

Breakpoint location. If you don't own this location instance, you must call Breakpoint settings Breakpoint options

Export an instance to get created when gets created

Called once by

Breakpoints service

Shows the breakpoint settings dialog box

Shows the breakpoint settings dialog box and returns the new settings or null if the user canceled

Settings to edit

Edits a breakpoint's settings

Breakpoint

Edits breakpoint settings and writes the new settings to

Breakpoints

Provides all the values of the variables that can be used by the filter expression

Machine name

Process id

Process name

Thread id

Thread name

Evaluates breakpoint filter expressions. Use to export an instance.

Checks if is a valid expression. Returns null if it's a valid expression, otherwise an error string is returned.

Filter expression

Evaluates and returns the result of the expression.

Filter expression Provides the values of the variables that can be used by the expression

Parses and writes text and color to

Output Expression

Result of evaluating a filter expression

Result if is false

Error message if is true

true if there was an error

Constructor

Error

Constructor

Result of evaluated expression

Metadata

See

Exports a instance

Constructor

Order

Order

Writes breakpoints info used by breakpoint glyph margin code, eg. in tooltips. Use to export an instance.

Writes the text shown after "Location: " in tooltips when hovering over the breakpoint icon in the glyph margin. Returns true if something was written, and false if nothing was written.

Output Breakpoint Text view Span of breakpoint marker in the document

Metadata

See

Exports a instance

Constructor

Order

Order

Creates s. Use to export an instance.

Gets the location of the breakpoint or null

Breakpoint

Metadata

See

Exports a instance

Constructor

Order

Order

Module breakpoint

Gets the unique module breakpoint id

Gets/sets the current settings

true if the breakpoint is enabled

Name of module (case insensitive) or null/empty string if any name. Wildcards can be used

true if dynamic, false if not dynamic, and null if any value

true if in-memory, false if not in-memory, and null if any value

true if it was loaded, false if it was unloaded, and null if any value

Order or null if any value

App domain name (case insensitive) or null/empty string if any name. Wildcards can be used

Process name (case insensitive) or null/empty string if any name. Wildcards can be used

Removes this breakpoint from the module breakpoints list

Module info

Name of module

true if dynamic

true if in-memory

true if it was loaded, false if it was unloaded

Order

App domain name

Process name

Constructor

Module true if it was loaded, false if it was unloaded

Module breakpoint settings

true if the breakpoint is enabled

Name of module (case insensitive) or null/empty string if any name. Wildcards can be used

true if dynamic, false if not dynamic, and null if any value

true if in-memory, false if not in-memory, and null if any value

true if it was loaded, false if it was unloaded, and null if any value

Module load order or null if any value

App domain name (case insensitive) or null/empty string if any name. Wildcards can be used

Process name (case insensitive) or null/empty string if any name. Wildcards can be used

Compares this instance to

Other instance

Compares this instance to

Other instance

Gets the hash code

Module breakpoints service

Modifies a breakpoint

Breakpoint New settings

Modifies breakpoints

New settings

Raised when breakpoints are modified

Gets all breakpoints

Raised when is changed

Adds a breakpoint

Breakpoint settings

Adds breakpoints

Breakpoint settings

Removes a breakpoint

Breakpoint to remove

Removes breakpoints

Breakpoints to remove

Removes all module breakpoints

Finds breakpoints

Module

Checks if matches at least one breakpoint

Module

Breakpoint and old settings

Gets the breakpoint

Gets the old settings

Constructor

Breakpoint Old settings

Breakpoints modified event args

Gets the breakpoints

Constructor

Breakpoints and old settings

Breakpoint and settings

Gets the breakpoint

Gets the new settings

Constructor

Breakpoint New settings

Provides all stack frames shown in the call stack window

Gets the selected thread. This is identical to

Index of active thread. This could be invalid if is empty

Gets the active frame or null if is empty

Gets all frames. This is a truncated list if there are too many frames

Raised when is changed

Frames changed event args

true if there are new frames available

true if active frame index changed

Constructor

true if there are new frames available true if active frame index changed

Contains the stack frames and related info

Gets all frames

true if there are too many frames and is a truncated list of all frames

Index of active thread. This could be invalid if is empty

Gets the active frame or null if is empty

Constructor

All frames true if there are too many frames and is a truncated list of all frames Index of active thread. This could be invalid if is empty

A stack frame in a debugged process

Gets the process

Gets the runtime

Gets the AppDomain or null if it's unknown

Gets the thread

Gets the location or null if none. Can be passed to or can be used to create a breakpoint if you call

Gets the module or null if it's unknown

Gets the flags

Gets the offset of the IP relative to the start of the function

Gets the function token or if it doesn't have a token.

true if is valid

Closes this instance

Stack frame flags

No bit is set

Set if is the next statement to execute in this frame. It's also possible to set a BP at that location. It's false if is just an approximate location and it's not safe to set a BP at the location.

Walks the stack of a thread in a debugged process and creates s

Gets the process

Gets the runtime

Gets the thread

Gets the next frames or an empty list if there are no more frames

Max number of frames to return

Closes this instance. Any created s are not closed.

Converts s to s

Creates a or returns null

Frame

Creates stack frame spans in s

Called when there's new frames. It's always called before . The first frame (if it exists) should not be marked by this class.

New frames. These frames are owned by the caller and should not be closed by the callee.

Returns spans of the active statements set by . It shouldn't return duplicate spans. The first frame (if it exists) should not be marked by this class.

Text view Spans

Code location. There must be one owner per instance. If you must create a breakpoint using the same location, call and use the new instance as the breakpoint location.

Unique type, see . There should be a 1-1 correspondence between this string and the derived type.

Clones this instance. The returned instance can be used to create a breakpoint. Use to close it.

Closes this instance

Compares this instance to

Object

Gets the hash code

serializer. Use to export an instance.

Serializes

Destination section Breakpoint location

Deserializes a breakpoint location or returns null if it failed

Serialized section

Metadata

See

Exports a instance

Constructor

Type (compared against ), see

Constructor

Types (compared against ), see

Types (compared against ), see

Predefined types

.NET code location with a module, token, and IL offset

.NET (CorDebug): native breakpoint location

Creates breakpoint locations in text views

Creates a new instance whose text view span is >=

Tab Text view Position

Text view locations

Gets all locations

Gets the span

Constructor

Location Text view span

Constructor

Location Text view span

Constructor

Locations Text view span

Constructor

Locations Text view span

An application domain

Raised when a property is changed

Gets the runtime

Gets the process

Gets the name of the app domain

Gets the app domain id

Gets the app domain object created by the debug engine

Gets all modules

Contains added or removed objects

The objects that got added or removed (see )

true if were added, false if they were removed

Constructor

The objects that got added or removed (see ) true if were added, false if they were removed

Constructor

The objects that got added or removed (see ) true if were added, false if they were removed

Constructor

The object that got added or removed (see ) true if was added, false if it was removed

Invokes code on another thread.

Throws if the current thread isn't the dispatcher thread

Checks whether the current thread is the dispatcher thread

Executes code asynchronously on the dispatcher thread. This method returns immediately even if it happens to be called on the dispatcher thread.

Code to execute

Target environment

Gets the environment keys and values

Constructor

Copy constructor

Other instance

Clears the environment

Removes a key from the environment

Key

Adds a key and value to the environment

Key Value

Adds values to the environment

Environment

Image layout

Unknown layout

File layout

Memory layout

Base class of a app domain object implemented by the debug engine

Gets the app domain

Base class of a module object implemented by the debug engine

Gets the module

Base class of a runtime object implemented by the debug engine

Gets the runtime

Manages all debug engines. All events are raised on the dispatcher thread. If you need to hook events before debugging starts, you should export an . It gets called when gets called for the first time.

Gets the dispatcher. All debugger events are raised on this thread. is also called on this thread including disposing of data added by eg. .

Raised on the debugger thread when there's a new message, eg. a process was created, a thread has exited, etc. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Raised on the debugger thread when there's a new message. The listeners can pause the debugged program by setting to true.

Starts debugging. Returns an error string if it failed to create a debug engine, or null on success. See on how to get called the first time this method gets called.

Options needed to start the program or attach to it

true if can be called

Restarts the debugged program(s)

true if a program is being debugged

Raised when is changed

true if all processes are running, false if they're all paused, and null if some are running and some are paused. This property is valid only if is true.

Raised when is changed, see also

Raised when all processes have been running for a little while, eg. 1 second.

Gets all debug tags, see

Raised when is changed

Raised when a process gets paused due to some event in the process. If more than one process is being debugged, this is normally only raised once, for the first process.

Gets all debugged processes. Can be empty even if is true if the process hasn't been created yet.

Raised when is changed

Pauses all debugged processes

Lets all programs run again. This is the inverse of

Lets run again. If is true, all other processes will also run.

Process to run

Stops debugging. All programs started by the debugger will be terminated. All other programs will be detached, if possible, else terminated.

Terminates all debugged programs

Detaches all debugged programs, if possible. If it's not possible to detach a program, it will be terminated.

true if can be called without terminating any programs

Gets the current process

Raised when is changed

Gets the current runtime

Raised when is changed

Gets the current thread

Raised when is changed

Raised when the module's memory has been updated (eg. decrypted)

Returns true if the runtime can be debugged

Process id Runtime id

Closes

Object to close

Closes

Objects to close

Writes a message that will be shown in the output window

Message

Shows an error message and returns immediately

Error message

Writes a message

Message kind, see Message

Raised when gets called. This event is raised on a random thread.

Predefined message kinds, see

Output window

An error message that should be shown to the user

Messages by the stepper

Message event args

Gets the message kind, see

Gets the message

Constructor

Message kind, see Message

Contains the current object and the object that caused the debugger to enter break mode

Type of object

Gets the current object or null if none

Gets the object that caused the debugger to enter break mode

changed event args

true if changed

true if changed

Constructor

true if changed true if changed

Process paused event args

Gets the process

Gets the thread or null if unknown

Constructor

Process Thread or null if unknown

Debugger message kind

A process was created ()

A process has exited ()

A runtime was created ()

A runtime has exited ()

An app domain was loaded ()

An app domain was unloaded (). This message isn't sent if the program has exited.

A module was loaded ()

A module was unloaded (). This message isn't sent if the program has exited or if its app domain has unloaded.

A thread was created ()

A thread has exited (). This message isn't sent if the program has exited.

An exception was thrown ()

The entry point has been reached (). This message is only sent if the user chose to break at the entry point.

Message from the debugged program ()

A bound breakpoint was hit ()

The program paused itself by executing a break instruction or method ()

Step into/over/out is complete ()

SetIP() is complete ()

Some message that should be shown to the user, eg. we failed to connect to the debugged process ()

The program was paused by the user, or because some other program was paused for some other reason ()

Message from the debugged program ()

Base class of all debugger messages

Gets the message kind

true if the program should be paused. It's only possible to write true to this property.

Process message base class

Gets the process

Constructor

Process

Process created message ()

Returns

Constructor

Process

Process exited message ()

Returns

Gets the exit code

Constructor

Process Process exit code

Runtime message base class

Gets the runtime

Constructor

Runtime

Runtime created message ()

Returns

Constructor

Runtime

Runtime exited message ()

Returns

Constructor

Runtime

App domain message base class

Gets the app domain

Constructor

App domain

App domain loaded message ()

Returns

Constructor

App domain

App domain unloaded message ()

Returns

Constructor

App domain

Module message base class

Gets the module

Constructor

Module

Module loaded message ()

Returns

Constructor

Module

Module unloaded message ()

Returns

Constructor

Module

Thread message base class

Gets the thread

Constructor

Thread

Thread created message ()

Returns

Constructor

Thread

Thread exited message ()

Returns

Gets the exit code

Constructor

Thread Thread exit code

Exception thrown message ()

Returns

Gets the exception

Constructor

Exception

The entry point has been reached (). This message is only sent if the user chose to break at the entry point.

Returns

Gets the runtime

Gets the thread or null if it's unknown

Constructor

Runtime Thread or null if it's unknown

Message from the debugged program ()

Returns

Gets the text

Gets the runtime

Gets the thread or null if it's unknown

Constructor

Message Runtime Thread or null if it's unknown

A bound breakpoint was hit ()

Returns

Gets the bound breakpoint

Gets the thread or null if it's unknown

Constructor

Bound breakpoint Thread or null if it's unknown

The program paused itself by executing a break instruction or method ()

Returns

Gets the runtime

Gets the thread or null if it's unknown

Constructor

Runtime Thread or null if it's unknown

Step into/over/out is complete ()

Returns

Gets the runtime

Gets the thread

Gets the error message or null if none

true if there was an error. Error message is in

Constructor

Thread Error message or null if none

SetIP() is complete ()

Returns

Gets the runtime

Gets the thread

true if all frames in the thread have been invalidated

Gets the error message or null if none

true if there was an error. Error message is in

Constructor

Thread true if all frames in the thread have been invalidated Error message or null if none

A message that should be shown to the user

Returns

Gets the message kind

Gets the message

Constructor

Message kind Message

message kinds

We failed to connect to the debugged process

Could not break the debugged process

The program was paused by the user, or because some other program was paused for some other reason ()

Returns

Gets the runtime

Gets the thread or null if it's unknown

Constructor

Runtime Thread or null if it's unknown

Message source kind

Some other source

Standard output text

Standard error text

Message from the debugged program ()

Returns

Gets the message source kind

Gets the text

Gets the runtime

Constructor

Source Message Runtime

A module in a process

Raised when a property is changed

Gets the runtime

Gets the process

Gets the app domain or null if it's a process module

Gets the module object created by the debug engine

true if it's an EXE file, false if it's a DLL file

true if and are valid

Address of module. Only valid if is true

Size of module. Only valid if is true

Image layout

Name of module

Filename if it exists on disk, else it could be any longer name

true if it's a dynamic module (the application can add more types and members to the module at runtime)

true if it's an in-memory module

true if it's an optimized module, false if it's an unoptimized module, and null if it's a native module.

Load order of this module

Timestamp (UTC) of module (eg. as found in the PE header) or null

Gets the version, eg. the file version, see

Raised when the module's memory has been updated (eg. decrypted)

Gets incremented when the module gets refreshed ()

Notifies the debugger that the memory of a module has been updated (eg. decrypted)

Raised when the module's memory has been updated (eg. decrypted). The debugger will try to reset all breakpoints.

event args

Gets the modules

Constructor

Module

Constructor

Modules

Base class of debugger objects that only exist while debugging

Constructor

true if the instance has been closed

Raised when it's closed. Data methods eg. can be called but some other methods could throw or can't be called. After all handlers have been notified, all data get disposed (if they implement ).

Closes the instance. This method must only be executed on the dispatcher thread This method must only be called by the owner object.

Dispatcher

Called by after it has raised and before it disposes of all data. This method is called on the dispatcher thread (see )

Dispatcher

Checks if the data exists or is null

Type of data

Gets or creates data. If it implements , it will get disposed when this object gets closed.

Type of data

Gets data

Type of data Result

Gets existing data or throws if the data doesn't exist

Type of data

Gets or creates data. If it implements , it will get disposed when this object gets closed.

Type of data Creates the data if it doesn't exist

A debugged process

Raised when a property is changed

Gets the owner debug manager

Process id

Gets all runtimes

Raised when is changed

Gets the process bitness (32 or 64)

Gets the size of a pointer

Gets the architecture

Gets the operating system

Gets the process state

Gets the filename or an empty string if it's unknown

Gets the process name or an empty string if it's unknown

What is being debugged. This is shown in the UI (eg. Processes window)

Gets all threads

Raised when is changed

true if the process is running, false if it's paused or terminated (see )

Raised when is changed, see also

Raised when the process has been running for a little while, eg. 1 second.

Reads memory. Unreadable memory is returned as 0s.

Address in the debugged process Destination address Number of bytes to read

Reads memory. Unreadable memory is returned as 0s.

Address in the debugged process Destination buffer Destination index Number of bytes to read

Reads memory. Unreadable memory is returned as 0s.

Address in the debugged process Destination buffer

Reads memory. Unreadable memory is returned as 0s.

Address in the debugged process Number of bytes to read

Writes memory.

Address in the debugged process Source address Number of bytes to write

Writes memory.

Address in the debugged process Source buffer Source index Number of bytes to write

Writes memory.

Address in the debugged process Source buffer

true if the process gets detached when debugging stops (), false if the process gets terminated.

Stops debugging. This will either detach from the process or terminate it depending on

Detaches the process, if possible, else it will be terminated

Terminates the process

Pauses the process

Lets the process run again

Architecture

x86, 32-bit

x64, 64-bit

32-bit ARM

64-bit ARM

Operating system

Windows OS

OSX/MacOS OS

Linux OS

FreeBSD OS

Process state

The process is running

The process is paused

The process is terminated

A runtime in a process

Gets the process

Gets the process unique runtime id. There must be exactly one such id per process.

Gets the runtime GUID, see

Gets the runtime kind GUID, see

Gets the runtime name

Gets all runtime tags

Gets the runtime object created by the debug engine

Gets all app domains

Raised when is changed

Gets all modules

Raised when is changed

Gets all threads

Raised when is changed

Gets the break infos, it gets updated when the runtime breaks and cleared when it continues.

Closes just before the runtime continues (or when it gets closed if it never continues)

Object

Closes just before the runtime continues (or when it gets closed if it never continues)

Objects

Closes when the runtime closes

Object

Closes when the runtime closes

Objects

Closes when the runtime closes

Object

Closes when the runtime closes

Objects

Break info kind

Unknown break reason

We've connected to the debugged process

It's paused due to some debug message. is a

Break info

Gets the kind

Gets the data, see for more info

Constructor

Kind Data

Constructor

Debug message

ToString()

Contains state and localized state that can be shown in the UI

Non-localized string

Localized string (shown in the UI)

Constructor

State

Constructor

State (non-localized) Localized state

Equals()

Equals()

Gets the hash code

Returns

A thread in a debugged process

Raised when a property is changed

Gets the runtime

Gets the process

Gets the app domain or null if it's a process thread

true if this is the main thread

Gets the thread kind, see

Gets the id of this thread

Gets the managed id of this thread or null if it's unknown or if it's not a managed thread

Gets the thread name

Gets the thread name shown in the UI

Gets the suspended count. It's 0 if the thread isn't suspended, and greater than zero if it's suspended.

Thread state

Returns true if the thread has a name

Freezes the thread

Thaws the thread

Creates a new instance that can be used to get the call stack.

Gets the top stack frame or null if there's none

Gets the first frames. The returned frame count can be less than if there's not enough frames available.

Max number of frames to return

Creates a stepper. The caller must close the returned instance by calling .

Sets a new instruction pointer

New location

Checks if can be called

New location

Global debugger settings. This class is thread safe. Listeners will be notified on a random thread.

Raised when a property is changed

Raises

Name of property that got changed

true to use hexadecimal numbers, false to use decimal numbers

true to use digit separators

true to colorize debugger tool windows and other debugger UI objects

true to auto open the locals window when the debugger starts

Use modules loaded from memory instead of files. Useful if a module gets decrypted at runtime.

true if properties and methods can be executed (used by locals / watch windows)

Use ToString() or similar method to get a string representation of an object (used by locals / watch windows)

true to prevent detection of managed debuggers

true to patch IsDebuggerPresent() so it can't be used to detect native debuggers

true to patch CheckRemoteDebuggerPresent() so it can't be used to detect native debuggers

true to patch NtRaiseHardError() so it can't be used to trigger kernel faults.

true to patch CloseHandle() so it can't be used to detect debuggers.

true to ignore break instructions and method calls

true to break all processes when one process breaks

true to enable Managed Debugging Assistants (MDA)

true to enable Just My Code debugging support

Step over code in system modules

Only step into code in primary module

Highlights the value of a variable that has changed in variables windows

Shows raw structure of objects in variables windows

Sort parameters (locals window)

Sort locals (locals window)

Group parameters and locals together (locals window)

Show compiler generated variables (locals/autos window)

Show decompiler generated variables (locals/autos window)

Hide compiler generated members in variables windows (respect debugger attributes, eg. )

Respect attributes that can hide a member, eg. and

Hide deprecated members

Suppress JIT optimization on module load (system modules). If false, the code will be optimized and much more difficult to debug (it will be like when attaching to a process). System modules are all non-program modules (eg. GAC assemblies).

Suppress JIT optimization on module load (program modules). If false, the code will be optimized and much more difficult to debug (it will be like when attaching to a process). All modules in the same folder, or sub folder, as the main executable are considered program modules.

Give focus to the active process

Give focus to the debugger when eg. a breakpoint is hit

Show return values in Locals window

Redirect GUI applications' console output to the Output window

Show only public members in variables windows

Show all locals. Captured variables aren't shown, their display classes are shown instead.

Async debugging (step over await statements, step out of async methods)

Step over properties and operators

Ignore unhandled exceptions

Show the full string value even if it's a very long string

Debug program base class

Clones this instance

Service used to display an edit dialog for a

Display an edit dialog for the given set of environment variables.

The environment to edit true if the environment was modified, false otherwise

Returns a method's native code

Checks if it's possible to get native code

Stack frame

Tries to get the native code

Stack frame Options Native code if successful

Checks if it's possible to get native code

A bound breakpoint

Tries to get the native code

A bound breakpoint Options Native code if successful

Checks if it's possible to get native code

Runtime Code location

Tries to get the native code

Runtime Code location Options Native code if successful

Native code result

Native code

Symbol resolver or null

Header or null

Constructor

Native code Symbol resolver or null Header or null

Native code options

No option is enabled

Show IL code, if available

Show source code or decompiled code, if available

Returns native method bodies. Use to export an instance.

Checks if it's possible to get native code

Stack frame

Tries to get the native code

Stack frame Options Native code if successful

Checks if it's possible to get native code

A bound breakpoint

Tries to get the native code

A bound breakpoint Options Native code if successful

Checks if it's possible to get native code

Runtime Code location

Tries to get the native code

Runtime Code location Options Native code if successful

Metadata

See

See

See

Exports a instance

Constructor

Runtime GUID or null, see Runtime kind GUID or null, see Order

Gets the runtime GUID or null, see

Gets the runtime kind GUID or null, see

Order

Stack frame implemented by a

Gets the module or null if it's unknown

Gets the location or null if none. Can be passed to

Gets the offset of the IP relative to the start of the function

Gets the flags

Gets the function token or if it doesn't have a token.

Invalid function token

Formats the stack frame or returns false

Evaluation context Output Stack frame options Value option Culture or null to use invariant culture Cancellation token

Called after the has been created

Stack frame

Creates s

Gets the next frames or an empty list if there are no more frames

Max number of frames to return

A debug engine contains all the logic to control the debugged process

How was the debugged process started?

Contains properties used to create a . This property is called after the engine has connected and just before the instance is created.

Gets all debug tags, see

What is being debugged. This is shown in the UI (eg. Processes window)

Called when the engine can start or attach to the debugged process. This method is called shortly after this instance gets created by a call to . It must send a message when it has connected to the program or if it failed.

Same options that were passed to

Raised when there's a new message. It can be raised on any thread.

Creates a instance. It's called by the runtime constructor.

Runtime instance

Called when its connected message has been received by

Object factory Runtime

Pauses the debugged program, if it's not already paused. This is an asynchronous method. Once the program is paused (even if it already was paused), message must be sent.

Lets the program run again. This is an asynchronous method. No message is sent.

Terminates the debugged program. This is an asynchronous method. This method gets called when the user chooses Terminate All from the Debug menu When the program has been terminated or detached, message must be sent.

true if the engine can detach from the debugged program without terminating it.

Detaches from the debugged program. If it's not possible, the program must be terminated. This is an asynchronous method. This method gets called when the user chooses Detach All from the Debug menu. When the program has been terminated or detached, message must be sent.

Freezes the thread

Thread

Thaws the thread

Thread

Removes all breakpoints. There's no guarantee that this method will be called to delete all bound breakpoints. To always get notified when a bound breakpoint gets deleted, add custom data that implements when creating the bound breakpoint, see eg.

Modules Bound breakpoints If false, remove breakpoints that exist in , and if true, remove breakpoints that exist in and all breakpoints not in a

Adds all breakpoints. To get notified when a bound breakpoint gets deleted, add custom data that implements when creating the bound breakpoint, see eg.

Modules Breakpoint locations. The engine can ignore non-supported locations. If false, add breakpoints that exist in , and if true, add breakpoints that exist in and all breakpoints not in a

Creates a stack walker

Thread created by this engine

Creates a stepper

Thread to step

Sets a new instruction pointer

Thread New location

Checks if can be called

Thread New location

Start kind

The program was started by the debugger

The debugger attached to the program after it was started by someone else

A class that can update a

Gets the app domain

Removes the app domain and disposes of it. The engine has paused the program.

Message flags

Properties to update

No option is enabled

Update

Update

Updates

New value

Updates

New value

Updates properties

Options New value New value

A class that can update a

Gets the bound breakpoint

Removes this bound breakpoint

Removes bound breakpoints

Breakpoints to remove

Properties to update

No option is enabled

Update

Update

Update

Updates

New value

Updates

New value

Updates

New value

Updates properties

Options New value New value New value

Bound breakpoint message kind

No warning or error, the breakpoint will break when hit

Custom warning message

Custom error message

Function wasn't found

A breakpoint could not be created

Bound breakpoint message

Message kind

Arguments

Creates a no-error message

Creates a custom warning message

Message

Creates a custom error message

Message

Creates a function-not-found message

Name of function

Creates a could-not-create-breakpoint message

Base class of messages created by a

Gets the message kind

Gets the message flags

Constructor

Message flags

event. Should be the first event sent by the debug engine. If it couldn't connect, no more messages need to be sent after this message is sent.

Returns

The error message or null if there's no error

Gets the process id

Constructor

Process id Message flags

Constructor

Error message Message flags

event

Returns

Gets the exit code

Constructor

Exit code Message flags

event

Returns

The error message or null if there's no error

Gets the thread or null if it's not known

Constructor

Thread or null if it's not known Message flags

Constructor

Error message Message flags

event

Returns

Gets the thread or null if it's not known

Constructor

Thread or null if it's not known Message flags

event

Returns

Gets the message

Gets the thread or null if it's not known

Constructor

Message Thread or null if it's not known Message flags

event

Returns

Gets the breakpoint

Gets the thread or null if it's not known

Constructor

Breakpoint Thread or null if it's not known Message flags

event

Returns

Gets the thread or null if it's not known

Constructor

Thread or null if it's not known Message flags

event

Returns

Gets the thread

true if all frames in the thread have been invalidated

Gets the error string or null if none

Constructor

Thread true if all frames in the thread have been invalidated Error string or null if none Message flags

event

Returns

Gets the message source

Gets the message

Constructor

Source Message

Message flags

No bit is set

Set if the process should be paused, false if other code gets to decide if it should pause

Set if the process should continue if possible, eg. it's a func-eval and an event occured.

Set if the process is running

kind

The engine has connected to the debugged process. This message is the first message sent by the , even on failure. If the connection was successful, the program must be paused until gets called.

The engine has been disconnected from the debugged process

The debugged executable is paused due to a call to or due to some other engine event.

Entry point has been reached. The engine has paused the program. This message is only sent if the user chose to break at the entry point.

Log message written by the debugged program. The engine has paused the program.

A breakpoint has been hit. The engine has paused the program.

The program paused itself by executing a break instruction or method

SetIP() is complete

Message written by the debugged program. The program is still running. This message is sent when a GUI app writes to the console.

A class that can update a

Gets the module

Removes the module and disposes of it. The engine has paused the program.

Message flags

Properties to update

No option is enabled

Update

Update

Update

Update

Update

Update

Update

Update

Update

Update

Update

Update

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates properties

Options New value New value New value New value New value New value New value New value New value New value New value New value

Creates instances. Use to export an instance.

Creates a or returns null if is unsupported

Debug manager Options

Metadata

See

Exports a instance

Constructor

Order

Order

Created by a

GUID returned by

GUID returned by

Name returned by

Id returned by

Tags returned by

Constructor

GUID returned by GUID returned by Name returned by Id returned by Tags returned by

A class that can update a

Gets the thread

Removes the thread and disposes of it. The engine has paused the program.

Message flags

Properties to update

No option is enabled

Update

Update

Update

Update

Update

Update

Update

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates

New value

Updates properties

Options New value New value New value New value New value New value New value

Used by a to create new modules, threads, etc.

The engines don't need to worry about locks, or raising events in the correct thread, or updating collections in the right thread, or closing dbg objects, etc... It's taken care of by dnSpy.

Gets the debug manager

Gets the process

Gets the runtime

Creates an app domain. The engine has paused the program.

App domain object created by the debug engine New value New value Message flags

Creates an app domain. The engine has paused the program.

Type of data App domain object created by the debug engine New value New value Message flags Data to add to the or null if nothing gets added Called right after creating the app domain but before adding it to internal data structures. This can be null.

Creates a module. The engine has paused the program.

New value Module object created by the debug engine New value New value New value New value New value New value New value New value New value New value New value New value Message flags

Creates a module. The engine has paused the program.

Type of data New value Module object created by the debug engine New value New value New value New value New value New value New value New value New value New value New value New value Message flags Data to add to the or null if nothing gets added Called right after creating the module but before adding it to internal data structures. This can be null.

Creates a thread. The engine has paused the program.

New value New value New value New value New value New value New value Message flags

Creates a thread. The engine has paused the program.

Type of data New value New value New value New value New value New value New value Message flags Data to add to the or null if nothing gets added Called right after creating the thread but before adding it to internal data structures. This can be null.

Creates an exception. The engine has paused the program.

Exception id Exception event flags Exception message or null if it's not available Thread where exception was thrown or null if it's unknown Module where exception was thrown or null if it's unknown Message flags

Creates an exception. The engine has paused the program.

Exception id Exception event flags Exception message or null if it's not available Exception HResult or null if it's not available Thread where exception was thrown or null if it's unknown Module where exception was thrown or null if it's unknown Message flags

Creates an exception. The engine has paused the program.

Type of data Exception id Exception event flags Exception message or null if it's not available Thread where exception was thrown or null if it's unknown Module where exception was thrown or null if it's unknown Message flags Data to add to the or null if nothing gets added Called right after creating the exception but before adding it to internal data structures. This can be null.

Creates an exception. The engine has paused the program.

Type of data Exception id Exception event flags Exception message or null if it's not available Exception HResult or null if it's not available Thread where exception was thrown or null if it's unknown Module where exception was thrown or null if it's unknown Message flags Data to add to the or null if nothing gets added Called right after creating the exception but before adding it to internal data structures. This can be null.

Value used when the bound breakpoint's address isn't known

Creates a bound breakpoint. This method returns null if there was no breakpoint matching . To get notified when a bound breakpoint gets deleted, add custom data that implements .

Breakpoint location Module or null if none Address or if unknown Warning/error message or default if none

Creates a bound breakpoint. This method returns null if there was no breakpoint matching . To get notified when a bound breakpoint gets deleted, add custom data that implements .

Type of data Breakpoint location Module or null if none Address or if unknown Warning/error message or default if none Data to add to the or null if nothing gets added

Creates bound breakpoints. Locations that don't match an existing breakpoint are ignored, and all user data are disposed if they implement . To get notified when a bound breakpoint gets deleted, add custom data that implements .

Type of data Bound breakpoints to create

Creates a special stack frame that's displayed as [name], eg. [Managed to Native Transition]

Name, eg. "Managed to Native Transition" Location or null Module or null Function offset Function token

Bound breakpoint info

Type of data

Value used when the bound breakpoint's address isn't known

Gets the location

Gets the module or null if none

Gets the address or if it's not known

Gets the warning/error message or default if none

Gets the data to add to the or null if nothing gets added. If the data implements , it gets disposed when the bound breakpoint gets deleted.

Constructor

Location Module or null if none Address or if it's not known Warning/error message or default if none Data to add to the or null if nothing gets added. If the data implements , it gets disposed when the bound breakpoint gets deleted.

Expression evaluator

Creates evaluator state used to cache data that is needed to evaluate an expression

Evaluates an expression

Evaluation info Expression to evaluate Options State created by or null to store the state in 's context

Assigns the value of an expression to another expression

Evaluation info Target expression (lhs) Source expression (rhs) Options

Evaluation result

Gets the value or null if there was an error

Gets the format specifiers, if any

Gets the flags

Gets the error or null if none

Constructor

Value Format specifiers or null Flags

Constructor

Error message Flags

Expression evaluator assignment result

Error message or null

Gets the flags

true if the error is from the compiler and no debuggee code was executed

Constructor

Result flags Error message or null

Formats names, types, values, stack frames

Formats an exception name

Evaluation context Output Exception id

Formats a stowed exception name

Evaluation context Output Stowed exception id

Formats a return value name

Evaluation context Output Return value id

Formats an object ID name

Evaluation context Output Object id

Formats a stack frame

Evaluation info Output Stack frame options Value option Culture or null to use invariant culture

Formats a value

Evaluation info Output Value to format Options Culture or null to use invariant culture

Formats a value's type

Evaluation info Output Value to format Options Culture or null to use invariant culture

Debugger language that evaluates expressions and formats values

Gets the language name, see

Gets the language's display name (shown in the UI)

Gets the expression evaluator

Gets the formatter

Gets the locals and parameters provider

Gets the autos provider

Gets the exceptions provider

Gets the return values provider

Gets the type variables provider

Gets the static fields provider

Gets the factory

Initializes an evaluation context

Context Location or null Cancellation token

Creates s. Use to export an instance.

Gets the runtime display name, eg. ".NET"

Creates all languages

Metadata

See

See

Exports a instance

Constructor

Runtime kind GUID, see Order

Runtime kind GUID, see

Order

References a value in the debugged process

Gets the unique id in the runtime

Creates a new value

Evaluation info

Creates s. Use to export an instance.

Returns true if it's possible to create an object id

Value created by this runtime

Creates an object id or returns null

Value created by this runtime Unique id

Checks if an object id and a value refer to the same data

Object id created by this class Value created by this runtime

Gets the hash code of an object id

Object id created by this class

Gets the hash code of a value created by this runtime

Value created by this runtime

Metadata

See

See

Exports a instance

Constructor

Runtime GUID, see Order

Runtime GUID, see

Order

Result of evaluating an expression

Gets the value object created by the debug engine

Type of the value

true if is valid

The value. It's only valid if is true. A null value is a valid value. If it's an enum value, it's stored as the enum's underlying type (eg. )

Gets the address of the value or null if there's no address available. The returned address gets invalid when the runtime continues.

If true and if it's a supported type (eg. a simple type such as integers, floating point values, strings or byte arrays) the returned object contains the address of the actual value, else the returned address and length covers the whole object including vtable, method table or other special data.

A value shown in a treeview (eg. in locals window)

Gets the error message or null

Gets the value or null if none

Gets the expression that is used when adding an expression to the watch window or when assigning a new value to the source.

Image name, see

true if this is a read-only value

true if the expression causes side effects

Returns true if it has children, false if it has no children and null if it's unknown (eg. it's too expensive to calculate it now). UI code can use this property to decide if it shows the treeview node expander ("|>").

Number of children. This method is called as late as possible and can be lazily initialized. It's assumed to be 0 if is false.

Evaluation info

Creates new children

Evaluation info Index of first child Max number of children to return Options

Formats the name, value, and type

Evaluation info Options Culture or null to use invariant culture

Writes a new value

Evaluation info Source expression (rhs) Options

Assignment result

Gets the error message (also see ) or null if none

Gets the flags

Constructor

Result flags Error message or one of the errors in

Creates s

Creates s

Evaluation info Expressions to evaluate

Creates s

Evaluation info Object ids Options

Provides s for the variables windows

Gets all values

Evaluation info Options

Provides s for the locals windows

Gets all values

Evaluation info Options Locals value node provider options

Contains a value node and its kind

What kind of value this is (local or parameter)

Gets the node

Constructor

What kind of value this is (local or parameter) Value node

Common error messages

Some error

is set but expression causes side effects

or is set but code must call a method

Function evaluation timed out

Function evaluation timed out previously and is disabled until the user continues the debugged program

The debugged program isn't paused so it's not possible to func-eval

It's not possible to func-eval when an unhandled exception has occurred

It's not possible to func-eval, eg. because we're already func-eval'ing

It's not possible to func-eval because the thread isn't at a safe point where a GC can occur

Can't func eval since all threads must execute (the code called )

Can't read local or argument because it's not available at the current IP or it's been optimized away

Runtime can't read a field, local

Converts values to localized strings

Gets a message

An error message (eg. one in )

Step kind

Step into

Step over

Step out

Steps into, over or out of a method. When closed, any non-completed call must be canceled.

Raised when the step is complete

Steps once. This method can be called again once is raised. This method is only called if the engine is paused.

This value must be used when raising Step kind

Cancels the step, but does not raise

Same value that was passed to

Step complete event args

Gets the thread or null to use the default thread that was used to create the stepper

Gets the tag

Gets the error message or null if none

true if the stepper was canceled by the engine

Constructor

Thread or null to use the default thread that was used to create the stepper Same value that was passed to Error message or null if none true if the stepper was canceled by the engine

Evaluation context

Gets the language

Gets the process

Gets the runtime

This object gets closed (and recreated) when the process continues

Func-eval timeout (func-eval = calling functions in debugged process)

Context options

Closes this instance

Contains the classes needed to func-eval

Gets the evaluation context

Gets the stack frame

Gets the cancellation token

Gets the runtime

Constructor

Evaluation context Stack frame Cancellation token

Closes and

Contains the expression to evaluate and options

Gets the expression to evaluate

Gets the value node options

Gets the evaluation options

Expression evaluator state or null, see

Constructor

Expression to evaluate Value node options Evaluation options Expression evaluator state or null, see

Expression evaluator

Gets the language

Creates evaluator state used to cache data that is needed to evaluate an expression

Evaluates an expression. The returned is automatically closed when its runtime continues.

Evaluation info Expression to evaluate Options State created by or null to store the state in 's context

Assigns the value of an expression to another expression

Evaluation info Target expression (lhs) Source expression (rhs) Options

Evaluation options

No bit is set

Set if it's an expression, false if it's a statement

Fail if the expression causes side effects, eg. method calls

Don't allow function evaluations (calling code in debugged process)

Don't create a name/expression (only used by value nodes)

Use only the locals that exist in the metadata. Don't show captured variables, show their display class variables instead

Evaluation result flags

No bit is set

The expression causes side effects

The result is read-only

It's a boolean expression

The value is a thrown exception

Evaluation result

Gets the value or null if there was an error

Gets the format specifiers

Gets the flags

true if is a thrown exception

Gets the error or null if none

Constructor

Value Format specifiers or null Flags

Constructor

Error message Format specifiers or null Flags

Assignment result flags

No bit is set

The error is from the compiler and no debuggee code was executed

Code in the debuggee was executed

Expression evaluator assignment result

Error message or null

Gets the flags

true if the error is from the compiler and no debuggee code was executed

Constructor

Result flags Error message or null

Formats names, frames, values and types

Gets the language

Formats an exception name

Evaluation context Output Exception id

Formats a stowed exception name

Evaluation context Output Stowed exception id

Formats a return value name

Evaluation context Output Return value id

Formats an object ID name

Evaluation context Output Object id

Formats a stack frame

Evaluation info Output Stack frame options Value option Culture or null to use invariant culture

Formats a value

Evaluation info Output Value to format Options Culture or null to use invariant culture

Formats a value's type

Evaluation info Output Value to format Options Culture or null to use invariant culture

Debugger language that evaluates expressions and formats values

Gets the runtime kind GUID, see

Gets the language name, see

Gets the language's display name (shown in the UI)

Gets the expression evaluator

Gets the formatter

Gets the locals and parameters provider

Gets the autos provider

Gets the exceptions provider

Gets the return values provider

Gets the type variables provider

Gets the static fields provider

Gets the factory

Default func-eval timeout value

Creates an evaluation context

Runtime Location or null Options Func-eval timeout (func-eval = calling functions in the debugged process) or default instance to use default timeout value Cancellation token

Creates an evaluation context

Stack frame Options Func-eval timeout (func-eval = calling functions in the debugged process) or default instance to use default timeout value Cancellation token

Evaluation context options

No bit is set

Set if all threads should run when func-evaluating (calling code in the debugged process), or cleared if only one thread should run. Usually only one thread is run, but that can lead to a deadlock if the thread calls a suspended thread or if it tries to acquire a lock owned by a suspended thread.

If method body info isn't needed, this option should be used. It prevents decompiling the method to get sequence points and other debug info. Can be used when formatting stack frames.

Debugger language service

Gets all languages

Runtime kind GUID, see

Sets the language that should be used by all runtimes with GUID

Runtime kind GUID, see Language to use

Gets the current language the runtime uses

Runtime kind GUID, see

Raised when a runtime's current language is changed

Language changed event args

Runtime kind GUID, see

New language

Constructor

Runtime kind GUID, see New language

References a value in the debugged process

Gets the process

Gets the runtime

Gets the unique id in the runtime

Creates a new value. The returned is automatically closed when its runtime continues.

Evaluation info

Removes and closes the object id

Creates s

Raised when one or more non-hidden s are created or removed

Returns true if it's possible to create an object id

Value Options

Creates an object id or returns null

Value Options

Creates object ids. The returned array will contain null elements if it wasn't possible to create object ids

Values Options

Returns an non-hidden object id or null if there's none that references

Value

Returns a non-hidden object id or null if there's none

Runtime Object id

Gets all non-hidden object ids

Runtime

Removes and closes an object id

Object id to remove and close

Removes and closes object ids

Object ids to remove and close

Checks if an object id and a value refer to the same data

Object id Value

Gets the hash code of an object id

Object id

Object ID options

No bit is set

Hidden object Id. It's not shown in any of the variables windows.

Stack frame formatter options

No bit is set

Show module name, eg. module.dll!func

Show parameter types

Show parameter names

Show parameter values

Show declaring type

Show return type

Show namespace

Show intrinsic type keywords (eg. int instead of Int32)

Set if integers are shown in decimal, clear if integers are shown in hexadecimal

Show tokens

Show instruction pointer

Use digit separators

Show the full string value even if it's a very long string

Result of evaluating an expression

Gets the process

Gets the runtime

Gets the value object created by the debug engine

Type of the value

true if is valid

The value. It's only valid if is true. A null value is a valid value. If it's an enum value, it's stored as the enum's underlying type (eg. )

Gets the address of the value or null if there's no address available. The returned address gets invalid when the runtime continues.

If true and if it's a supported type (eg. a simple type such as integers, floating point values, strings or byte arrays) the returned object contains the address of the actual value, else the returned address and length covers the whole object including vtable, method table or other special data.

Closes this instance

Type of value

Some other type

There's no value

Boolean, is a boxed

1-byte char, is a boxed

Char, is a boxed

8-bit signed int, is a boxed

16-bit signed int, is a boxed

32-bit signed int, is a boxed

64-bit signed int, is a boxed

8-bit unsigned int, is a boxed

16-bit unsigned int, is a boxed

32-bit unsigned int, is a boxed

64-bit unsigned int, is a boxed

32-bit floating point number, is a boxed

64-bit floating point number, is a boxed

Decimal, is a boxed

32-bit pointer, is a boxed

64-bit pointer, is a boxed

UTF-16 string, is a or null

A , is a boxed

Contains the address and length of a value

Gets the address

Gets the length

Constructor

Address Length

Value formatter options

No bit is set

Set if it should be formatted so it can be edited

Set if integers are shown in decimal, clear if integers are shown in hexadecimal

Set to allow function evaluations (calling methods in the debugged process)

Set to allow calling methods to get a string representation of the value. must also be set. If it's a simple type (eg. an integer), it's formatted without calling any methods in the debugged process and this flag is ignored.

Use digit separators. This flag is ignored if is set and the language doesn't support digit separators

Don't show string quotes, just the raw string value

Don't use debugger display attributes

Show the full string value even if it's a very long string

Show namespaces. Only used if is clear

Show intrinsic type keywords (eg. int instead of Int32)

Show tokens. Only used if is clear

Type formatter options

No bit is set

Set if integers are shown in decimal, clear if integers are shown in hexadecimal

Use digit separators

Show namespaces

Show intrinsic type keywords (eg. int instead of Int32)

Show tokens

A value shown in a treeview (eg. in locals window)

Gets the language

Gets the process

Gets the runtime

true if this is an error value node

Gets the error message or null

true if is not null

Gets the value or null if there's none

true if it's a node that has an can be evaluated, false if it's a non-value node, eg. 'Type variables', 'Raw View', etc.

Gets the expression that is used when adding an expression to the watch window or when assigning a new value to the source. See also .

Image name, see

true if this is a read-only value

true if the expression causes side effects

Returns true if it has children, false if it has no children and null if it's unknown (eg. it's too expensive to calculate it now). UI code can use this property to decide if it shows the treeview node expander ("|>").

Number of children. This property is called as late as possible and can be lazily initialized. It's assumed to be 0 if is false.

Evaluation info

Creates new children. The returned s are automatically closed when their runtime continues

Evaluation info Index of first child Max number of children to return Options

Formats the name

Evaluation info Output Formatter options Culture or null to use invariant culture

Formats the value

Evaluation info Output Formatter options Culture or null to use invariant culture

Formats the expected type ("field" type)

Evaluation info Output Formatter options Value options Culture or null to use invariant culture

Formats the actual type (value type)

Evaluation info Output Formatter options Value options Culture or null to use invariant culture

Formats the name, value, and type

Evaluation info Options Culture or null to use invariant culture

Writes a new value

Evaluation info Source expression (rhs) Options

Assignment result

Gets the error message or null if none

Gets the flags

Constructor

Result flags Error message or null if none

Parameters when formatting a

Used when writing the name or null if it's not written

Used when writing the value or null if it's not written

Used when writing the expected type ("field" type) or null if it's not written

Used when writing the actual type (value type) or null if it's not written

Name formatter options

Value formatter options

Type formatter options

Expected type formatter options

Actual type formatter options

evaluation options

No bit is set

Don't allow function evaluations (calling code in debugged process)

Show the Results View only

Show the Dynamic View only

Show the raw view (don't use debugger type proxies)

Hide compiler generated members in variables windows (respect debugger attributes, eg. )

Respect attributes that can hide a member, eg. and

Only show public members

Roots can't be hidden

Hide deprecated members

Creates s

Gets the language

Creates s

Evaluation info Expression Value node options Eval options State created by or null to store the state in 's context

Creates a . The returned s are automatically closed when their runtime continues.

Evaluation info Expressions to evaluate

Creates s. The returned s are automatically closed when their runtime continues.

Evaluation info Object ids Options

Contains the created or an error message

Gets the created node

true if the expression wasn't evaluated because it causes side effects ( was used)

Constructor

New value node true if the expression wasn't evaluated because it causes side effects ( was used)

Provides s for the variables windows

Gets the language

Gets all values. The returned s are automatically closed when their runtime continues.

Evaluation info Options

Locals value node provider options

No bit is set

Show compiler generated variables ()

Show decompiler generated variables ()

Show raw locals ()

Provides s for the locals window

Gets the language

Gets all values. The returned s are automatically closed when their runtime continues.

Evaluation info Options Locals value node provider options

Value node kind

Unknown value

Parameter value

Local value

Error value

Contains a value node and its kind

What kind of value this is (local or parameter)

Gets the node

Constructor

What kind of value this is (local or parameter) Value node

Predefined language names. These aren't language display names, they're just unique language names.

No language is available

C#

Visual Basic

Image names returned by

Format specifiers used by variables windows https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-csharp

Use decimal

Use hexadecimal

No quotes, just show the raw string

Raw view only

Results view only

Dynamic view only

Show all members, even non-public ones

Emulate the code without real func-eval

No side effects, it implies

Allow func-eval even if is used and expression causes side effects (ac = always calculate)

Digit separators

No digit seaparators

Use the same expression that's shown in the edit text box

Use ToString() if available to format the value

Don't use ToString() to format the value

Use if available

Don't use

Show the full string value even if it's a very long string

Don't show the full string value if it's a very long string

Show namespaces

Don't show namespaces

Show intrinsic type keywords (eg. int instead of Int32)

Don't show intrinsic type keywords (eg. int instead of Int32)

Show tokens

Don't show tokens

Show compiler generated members

Don't show compiler generated members

Respect attributes that can hide a member, eg. and

Don't respect attributes that can hide a member, eg. and

Gets value formatter options

Format specifiers or null Default options

Gets value formatter type options

Format specifiers or null Default options

Gets value node evaluation options

Format specifiers or null Default options

Thrown exception in the debugged process

Gets the process

Gets the runtime

Gets the exception id

Gets the exception event flags

true if it's a first chance exception

true if it's a second chance exception

true if it's an unhandled exception. The program will be terminated if it tries to run again.

Exception message or null if none

Exception HResult or null if none

Thread where exception was thrown or null if it's not known

Module where exception was thrown or null if it's not known

Exception category definition

Gets the flags

Name, see also

Localized name shown in the UI

Shorter localized name shown in the UI

Constructor

Flags Name, see also Localized name shown in the UI Shorter localized name shown in the UI

Returns

Exception category flags

No bit is set

Exceptions are integer codes instead of strings

Exception code should be displayed in decimal and not in hexadecimal

Exception code is an unsigned integer

Exception condition settings

Exception condition type

Exception condition

Constructor

Condition type Condition

Exception condition type

Module name equals

Module name does not equal

Exception definition

Exception ID

Flags

Description shown in the UI or null

Constructor

Exception id Flags

Constructor

Exception id Flags Description shown in the UI or null

ToString()

Exception definition flags

No bit is set

Stop at first firing of exception

Stop at second firing of exception

Provides exception category definitions and exception definitions. Use to export an instance.

Gets exception files (*.ex.xml) that define exceptions and exception categories. If a relative filename is returned, it's relative to the assembly of the called type. There's no need to return files already in the debug directory.

Returns all exception category definitions

Returns all exception definitions

Metadata

See

Exports a instance

Constructor

Order

Order

Exception event flags

No bit is set

First chance exception

Second chance exception

Unhandled exception. The program will be terminated if it tries to run again.

Formats exceptions in the Exception Settings window. Use to export an instance.

Writes the exception name. Returns true if it wrote the name.

Writer Exception definition

Metadata

See

See

Exports a instance

Constructor

Category, see Order

Category, see

Order

Exception ID

Gets the id kind

Exception category, same as

Name of exception (case insensitive). This property is only valid if is true

Exception code. This property is only valid if is true

true if the exception has a code, and not a name

true if the exception has a name, and not a code

true if this is the default exception ID

Constructor for default ids

Exception category, same as

Constructor

Exception category, same as Name of exception, must not be null

Constructor

Exception category, same as Exception code

Constructor

Exception category, same as Exception code

Equals()

Other instance

Equals()

Gets the hashcode

ToString()

kind

Default ID

Code

Name

Exception settings

Flags

Conditions

Constructor

Flags Conditions or null

Equals()

Equals()

Gets the hash code

Exception settings service

Resets all exception settings and removes user-added exceptions

Modifies an existing exception. It raises if the new settings are not equal to the current settings.

Id of existing exception New settings

Modifies existing exceptions. It raises if the new settings are not equal to the current settings.

New settings

Raised when an exception is modified

Removes exception settings

IDs of all exceptions to remove

Adds an exception

Exception settings

Adds exceptions

Exception settings

Gets all exceptions

Raised when is changed

Returns the exception definition if it exists

Exception id Updated with the exception definition if the method returns true

Returns exception settings or false if the exception doesn't exist in the collection

Id of exception Updated with the exception settings if the method returns true

Returns exception settings. If the exception doesn't exist in the collection, the default exception settings is returned

Id of exception

Gets the category definition if it exists

Category, see Updated with the category definition if the method returns true

Gets all category definitions

Contains the exception definition and exception settings

Gets the definition

Gets the settings

Constructor

Exception definition Exception settings

Exception id and settings

Gets the exception id

Gets the settings

Constructor

Exception id Settings

event args

Gets the ID and new settings

Constructor

New settings

Predefined exception categories

.NET

MDA (Managed Debugging Assistants)

All exported classes implementing this interface get created the first time gets called.

Called the first time gets called. The code has a chance to hook events and do other initialization before a program gets debugged.

Debug manager instance

Predefined GUIDs ()

.NET Framework

.NET Framework

.NET

.NET

Unity

Unity

Mono

Mono

Predefined runtime kind guids ()

.NET

.NET

Predefined debug tags

.NET debugger

Predefined thread kinds, see also

Unknown thread kind

Main thread

Thread pool thread

Worker thread

Terminated thread

Garbage Collector thread

Finalizer thread

If passed to , the module gets loaded and selected in the treeview

Gets the module

true if the module should be read from memory and not from a file on disk

Constructor

Module true if the module should be read from memory and not from a file on disk

Loads modules (eg. in the Assembly Explorer treeview). Use to export an instance.

Returns true if it showed the reference, and false if the next handler should get called. This method is called on the UI thread.

Module reference Options, eg.

Loads modules in the treeview. Returns an array of modules that got loaded.

Modules to load. Unsupported modules can be ignored. Options

Load module options

No bit is set

The module load was caused by a non-user action

Always load the module from the process' address space instead of from the module's file on disk

Metadata

See

Exports a instance

Constructor

Order of this instance

Runtime id; unique per process

Compares this instance to another object

Other object

Gets the hash code

Debug a program base class. Created eg. by

Where to break, see

Copies this instance to

Destination

Predefined break kinds, see

Don't break, let the program run

Break as soon as the process has been created

Module static constructor or Entry point

Entry point

Process starter result flags

No bit is set

The file extension is not the normal extension

Starts a process without debugging

Checks if this instance supports starting the executable

Filename Contains extra information if it's a supported file

Starts the executable. Returns false and an error message if it failed or throws an exception

Filename Updated with an error message

Metadata

See

Exports a instance

Constructor

Order, see

Order

Predefined order constants

.NET

Default process starter that calls

Predefined options page display order constants

.NET Framework debug engine

.NET debug engine

Unity debug engine (start executable)

Unity debug engine (connect to a waiting executable)

Mono debug engine (start executable)

Mono debug engine (connect to a waiting executable)

A page shown in the 'debug an application' dialog box. It provides a UI object and creates a instance that is used to start the application.

Raised after a property is changed

Raises

Name of property that got changed

Guid of this page

Display order of the UI object compared to other instances, see

Name of debug engine shown in the UI, eg. ".NET Framework" or ".NET" or "Mono"

Gets the UI object

true if all options are valid and can be called. gets raised when this property is changed.

Initializes this instance to previous options

Options

Initializes this instance to default options. If is not an EXE file, then should be used to initialize this instance, else should be ignored.

Filename Default break kind, see Options or null

Gets all options. This method is only called if returns true

Returns true if this is a debug engine page that is compatible with a debug engine (see eg. )

Generic debug engine guid (see ) Only used if the method returns true and is the order to use if more than one instance returns true. (see )

Called when the dialog box gets closed

Contains the options and an optional filename

Gets the options

Filename or null

Gets the flags

Constructor

Options Filename or null Flags

Extra start options

No bit is set

The file extension is not the normal extension

Returned by

.NET Framework

.NET

.NET Mono

.NET Unity

Passed to a instance

Filename of the current selected file or an empty string

Constructor

Filename of the current selected file or an empty string

Creates instances. See also

Creates new instances

Context

Detects the debug engine that should be shown by default when showing the options. Use to export an instance.

Gets the guid of an engine (see )

Filename

Metadata

See

Exports a instance

Constructor

Order, see

Order

Predefined order constants

.NET Framework / .NET

Unity

.NET

Predefined generic debug engine guids

.NET Framework or compatible framework (eg. Mono)

.NET

Unity

Step kind

Step into

Step over

Step out

Step into (only one process executes, the other ones aren't started)

Step over (only one process executes, the other ones aren't started)

Step out (only one process executes, the other ones aren't started)

Steps into, over or out of a method

Gets the process

Gets the runtime

Gets the thread

true if it's possible to call (eg. process must be paused)

true if has been called but hasn't been raised yet

Raised when the step is complete

Steps once. This method can be called again once is raised. The method can only be called when its process is paused.

Step kind true to call once is raised

Cancels the step

Closes the stepper and cancels

Step complete event args

Gets the thread

Gets the error message or null if none

true if there was an error

Constructor

Thread Error message or null if none

An using a . It ignores all colors passed to it.

true if nothing has been written

Gets all the text

Constructor

Constructor

String builder

Writes text

Color Text

Writes a new line

Resets this instance

Gets all the text

Text colors used by formatters

Implements and stores all colors and text. The result can be passed to

Gets the text

Gets the text length

Gets the colors

Constructor

Writes text

Color Text

Clears the text and colors so the instance can be reused

Implements and writes to a

Constructor

Debug text writer

Writes text

Color Text

Writes text

Color Text

Writes text

Writes text

Color Text

Provides thread categories and images. Use to export an instance.

Returns the thread category info or null

Thread kind, see

Metadata

See

Exports a instance

Constructor

Order

Order

Thread category info

Image (an ImageReference struct)

Category

Constructor

Image Category