Share via

IDebugCanStopEvent2::CanStop

  • Article

Note

This article applies to Visual Studio 2015. 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

Notifies the debug engine (DE) whether or not to stop at the current code location or just continue execution.

Syntax

HRESULT CanStop (   
   BOOL fCanStop  
);  

int CanStop (   
   int fCanStop  
);

Parameters

fCanStop
[in] Non-zero (TRUE) if the DE should stop at the current code location; otherwise, zero (FALSE).

Return Value

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

Remarks

The receiver of this event typically calls the GetReason method to determine the reason the DE wants to stop, and then calls the IDebugCanStopEvent2::CanStop method with the appropriate response.

If the DE stops, it sends an event that describes the reason for stopping. There are typically two events that are sent, a user or signal break represented by the IDebugBreakEvent2 interface, and a breakpoint event represented by the IDebugBreakpointEvent2 interface.

See Also

IDebugCanStopEvent2
IDebugBreakEvent2
IDebugBreakpointEvent2
GetReason