IDebugActivateDocumentEvent2

The debug engine (DE) uses this interface to request a document to be loaded.

Syntax

IDebugActivateDocumentEvent2 : IUnknown

Notes for Implementers

The DE implements this interface when it needs a source file to be opened. This interface is implemented only by debug engines that work with or are a part of script interpreters. The IDebugEvent2 interface must be implemented on the same object as this interface (the SDM uses QueryInterface to access the IDebugEvent2 interface).

Notes for Callers

The DE creates and sends this event object when it needs to have a source file opened. The event is sent by using the IDebugEventCallback2 callback function supplied by the SDM when it attached to the program being debugged.

Methods in Vtable Order

The following table shows the methods of IDebugActivateDocumentEvent2.

Methods Description
GetDocument Gets the document to activate.
GetDocumentContext Gets the document context that describes the position within the document.

Remarks

A typical scenario in which this interface is used is if a parse error occurs in script code on an HTML page, the script DE sends this interface to the SDM so that the document with the parse error can be displayed.

Requirements

Header: msdbg.h

Namespace: Microsoft.VisualStudio.Debugger.Interop

Assembly: Microsoft.VisualStudio.Debugger.Interop.dll

See also