IVsDebugger.AdviseDebugEventCallback(Object) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Used by a client to receive notifications of debugger events. In general, use AdviseDebuggerEvents(IVsDebuggerEvents, UInt32) and UnadviseDebuggerEvents(UInt32) instead.

public:
 int AdviseDebugEventCallback(System::Object ^ punkDebuggerEvents);

public:
 int AdviseDebugEventCallback(Platform::Object ^ punkDebuggerEvents);

int AdviseDebugEventCallback(winrt::Windows::Foundation::IInspectable const & punkDebuggerEvents);

public int AdviseDebugEventCallback (object punkDebuggerEvents);

abstract member AdviseDebugEventCallback : obj -> int

Public Function AdviseDebugEventCallback (punkDebuggerEvents As Object) As Integer

Parameters

punkDebuggerEvents

Object

[in] Pointer to the IUnknown interface of an object that also implements IVsDebuggerEvents.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

This method allows a Visual Studio package to receive all debug events. This can be useful for establishing a custom communication channel between a package and a debug engine. This API should be used with care since it forwards all debug events.

The punkDebuggerEvents object needs to also implement IDebugEventCallback. It is strongly advised that if a package chooses to implement IDebugEventCallback in managed code, that ReleaseComObject be invoked on the various interfaces passed to Event.

COM Signature

From vsshell.idl:

HRESULT IVsDebugger::AdviseDebugEventCallback(  
   [in]IUnknown *punkDebuggerEvents  
);