Microsoft.VisualStudio.Debugger.DebugAdapterHost.Interfaces

Thrown when the debug adapter fails to launch. Provides information about where and what caused the launch to fail.

Creates a new instance of the class.

The message that describes the error. The type of launch failure that was encountered. The exception that is the cause of the current exception, or a null reference if no inner exception is specified.

Creates a new instance of the class.

The message that describes the error.

Creates a new instance of the class.

The message that describes the error. The exception that is the cause of the current exception, or a null reference if no inner exception is specified.

Initializes a new instance of the class with serialized data.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

Populates the with information about the exception.

The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination.

Additional messages generated during the launch process, including any generated by a custom adapter launcher.

The identifier of the adapter being launched.

The type of launch failure that was encountered.

The possible types of launch failure.

Unknown failure type.

Failure while reading or parsing JSON configuration.

Failure while starting the debug adapter process.

Failure while sending or processing the response to the 'launch' or 'attach' request.

Failure while sending or processing the response to the 'initialize' request.

Launch operation was cancelled by the user.

Defines a mechanism for customizing the launch and execution of a debug adapter. To provide a custom launcher, implement this interface and provide the CLSID of the implementation in the "CustomLauncher" field of the debugger's AD7Metrics.

Called before attempting to launch a debug adapter to allow the configuration to be modified.

Information describing the launch.

Called to launch a debug adapter.

Information describing the launch. Interface that allows operations to be performed on the target host. An representing the launched debug adapter, or null if the adapter was not launched. If null is returned, the adapter host will attempt to launch the debug adapter using information from the debugger's AD7Metrics or launch configuration.

Represents a process running on the target host of the current debugging session.

Process handle for local processes. If specified, the process will be cleaned up automatically if the host exits.

Standard Input stream of the process.

Standard Output stream of the process.

Terminates the process.

Indicates whether or not the process has exited.

Raised when the process exits.

Raised when the process produces error output.

Provides methods for interacting with files and processes on the target host of the current debugging session.

Provides an implementation-defined value that uniquely identifies the target host.

Indicates the type of platform of the target host.

Executes a command on the target host and waits for it to run to completion.

A description of the command, which will be shown in a wait dialog if necessary. The command to execute. The arguments to the command to execute. Timeout (in milliseconds) before the command will be aborted. Exit code of the command. The output of the command.

Executes a command asynchronously on the target host.

The command to execute. The arguments to the command to execute. An representing the launched process.

Executes a command asynchronously on the target host using the specified runtime.

The ID of the runtime to use to execute the command. The command to execute. The arguments to the command to execute. An representing the launched process.

Executes a command asynchronously on the target host using the specified runtime.

The ID of the runtime to use to execute the command. The command to execute. The arguments to the command to execute. A dictionary of environment variables to pass to the new process An representing the launched process.

Copies a file from the local host to the target host.

File on the local host. File on the target host.

Creates a folder on the target host.

Folder on the target host. The full path of the created folder on the target host.

Gets the path to a user-specific folder on the target host.

The path to a user-specific folder on the target host.

Type of platform of the target host.

Target host platform is unknown.

Target host platform is Windows.

Target host platform is Linux.

Target host platform is OSX / MacOS.

Contains information used to control the launch of a debug adapter.

JSON-formatted configuration data that will be provided to the debug adapter when launched.

Indicates the mode in which the debug adapter will be launched.

Indicates whether the debug adapter will be launched on the local machine or on a remote host.

If attaching to a process, indicates the process id of that process.

AD7 used for this debug connection.

Returns the value of a metric from the debug engine registration.

Name of the metric to retrieve. The value of the metric, or null if the metric is not present.

AD7 used for this debug connection.

Type of launch requested.

Debug adapter should launch the target process and begin debugging it.

Debug adapter should attach to an already-running process.

Debug adapter should launch the target process, but not actually debug it.

Location of target host.

Debug adapter should be launched on the local host.

Debug adapter should be launched on a remote host.

Defines a mechanism for registering and interacting with custom messages that extend the Visual Studio Code Debug Protocol. To provide custom requests or events, implement this interface and provide the CLSID of the implementation in the "CustomProtocolExtension" field of the debugger's AD7Metrics.

Called during debug adapter protocol initialization to allow custom message types to be registered.

Provides methods for registering custom debug protocol messages. Provides methods for requests to the debug adapter.

Provides methods for registering custom debug protocol messages.

Registers an event type that may be received from the debug adapter.

Type that defines the event. The method to invoke when an event of this type is received from the debug adapter.

Registers a client request type that may be received from the debug adapter.

Type that defines the request. Type that defines the arguments of the request. The method to invoke when a client request of this type is received from the debug adapter.

Registers a client request type that may be received from the debug adapter.

Type that defines the request. Type that defines the arguments of the request. Type that defines the response to the request. The method to invoke when a client request of this type is received from the debug adapter.

Sets a property that will be sent to the debug adapter in the "initialize" request. These are generally used to advertise supported features of the host to the adapter.

The name of the property to set. The value of the property.

Provides methods for sending requests to the debug adapter.

Sends a request to the debug adapter asynchronously.

Type of the arguments for the request. Type of the response expected for the request. The request to send. The method to invoke when the request completes successfully. The method to invoke when the request fails.

Sends a request to the debug adapter and waits for a response.

Type of the arguments for the request. Type of the response expected for the request. The request to send. The response to the request.

Sends a request to the debug adapter asynchronously.

Type of the arguments for the request. The request to send. The method to invoke when the request completes successfully. The method to invoke when the request fails.

Sends a request to the debug adapter and waits it to complete.

Type of the arguments for the request. The request to send.

Initializes the adapter. Use of this method is recommended rather than sending an "initialize" request directly to ensure that capabilities provided by Debug Adapter Host extensibility components are included in the set sent to the adapter.

"initialize" request to send to the adapter.

Launches the debuggee. This method is provided as a convenience to allow consumers of this API to launch using the configuration already provided when creating this adapter host instance.

Invoked when a debug protocol event is received from the adapter. Use of this event is recommended rather than directly subscribing to to ensure that events that are handled internally by the adapter host are filtered out.

Invoked when a debug protocol request is received from the adapter. Use of this event is recommended rather than directly subscribing to to ensure that requests that are handled internally by the adapter host are filtered out.

Base interface for all components that integrate with the Debug Adapter Host. Provides a mechanism for components to be initialized with the correct process-specific context.

Initializes the component.

The context for the process being debugged. The context provided is unique to a single process in a debugging session, and should not be cached across debugging sessions or shared.

Provides services and information relevant to the process being debugged.

Provides access to logging services.

Provides access to events related to a debugging session.

Gets a consumer-defined object that is unique to a single process being debugged.

Sets a consumer-defined object that is unique to a single process being debugged.

Defines a mechanism for receiving events from the Debug Adapter Host.

Invoked when debugging ends for a process. If multiple processes are being debugged simultaneously, other processes may still be running.

Invoked when the debug adapter host receives the list of supported capabilities from the adapter.

Invoked when the debug adapter host encounters an error that will cause the debugging session to end.

Invoked when the process being debugged has exited.

Invoked immediately before a Debug Adapter Protocol event is sent or received.

Invoked immediately before a Debug Adapter Protocol request is sent or received.

Invoked immediately before a Debug Adapter Protocol response is sent or received.

Provides data for the event.

Creates a new instance of the class.

The set of capabilities provided by the adapter.

Provides data for the event.

Creates a new instance of the class.

The exception that caused the debugging session to end.

Adds an additional message that will be shown to the user along with the exception details.

The message to add.

Retrieves the set of additional messages to display.

Indicates whether or not a message should be shown to the user for this exception.

Provides data for the event.

Creates a new instance of the class.

The exit code received from the process being debugged, if any.

Base class for all message preview events.

Creates a new instance of the class.

Indicates whether the message is being sent from or received by the host.

Indicates that the message is being sent from the debug adapter to the host.

Indicates that the message is being sent from the host to the debug adapter

Provides data for the event.

Creates a new instance of the class.

Indicates whether the message is being sent from or received by the host. The event being sent or received.

The event being sent or received. Modification of this object is not supported.

Provides data for the event.

Creates a new instance of the class.

Indicates whether the message is being sent from or received by the host. The protocol type of the request being sent or received. The arguments for the request being sent or received.

The protocol type of the request being sent or received.

The arguments for the request being sent or received. Modification of this object is not supported.

Provides data for the event.

Creates a new instance of the class.

Indicates whether the message is being sent from or received by the host. The response being sent or received.

The response being sent or received. Modification of this object is not supported.

Defines a mechanism for sending messages to the Debug Adapter Host log.

Logs a message to the Debug Adapter Host log.

The message to add to the log. The category of the message. The severity of the message.

Category of a log message.

General category, appropriate for most messages.

Message related to launching a debug adapter. All messages sent with this category will be displayed to the user if the adapter fails to launch, even if logging is not enabled.

Debugging information, not included in the log by default. Messages in this category can be enabled or disabled using the "/Verbosity" switch on the "DebugAdapterHost.Logging" command.

Severity of a log message.

Message is informational.

Message is a warning.

Message is an error.

Interface implemented on Debug-Adapter based objects. To use this in cases where the UI component has an SDM wrapper, first use IDebugQueryEngine2 to query for the engine IDebugProgram2 / IDebugThread2 / IDebugStackFrame2, and then do a managed cast.

Returns the protocol operations interface, which can be used to send custom requests to a debug adapter

Interface implemented on the Debug Property. This can be obtained from IDebugProperty interfaces and casting it to IDebugCustomVisualizerProperty. This is for CustomVisualizeHosts to obtain property specific visualizer information.

Flag to determine if the debug engine can replace this object for the visualizer.

The list of custom visualizers avaliable for this property.

Interface implemented on the Debug Property. This can be obtained from IDebugProperty interfaces and casting it to IProtocolHostDebugProperty.

Evaluate reference, used for results evaluated from an expression

The variable reference to the parent of this property. Use this field if there is no EvaluateReference.

The name of the variable to evaluate using the ParentVariableReference.

The guid of the current debug engine for this property.