Share via

IDebugEngineProgram2::Stop

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Stops all threads running in this program.

Syntax

HRESULT Stop( 
   void 
);

int Stop();

Return Value

If successful, returns S_OK; otherwise, returns an error code.

Remarks

This method is called when this program is being debugged in a multi-program environment. When a stopping event from some other program is received, this method is called on this program. The implementation of this method should be asynchronous; that is, not all threads should be required to be stopped before this method returns. The implementation of this method may be as simple as calling the CauseBreak method on this program.

Implementers should send an IDebugStopCompleteEvent2 when the program stops.

See also