IDebugCanStopEvent2::GetReason

Gets the reason why the debug engine (DE) wants to stop.

HRESULT GetReason( 
   CANSTOP_REASON* pcr
);
int GetReason( 
   out enum_CANSTOP_REASON pcr
);

Parameters

  • pcr
    [out] Returns a value from the CANSTOP_REASON enumeration that describes the reason for this event.

Return Value

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

Remarks

This method is typically called before the IDebugCanStopEvent2::CanStop method so the caller can determine whether to pass non-zero (TRUE) to the IDebugCanStopEvent2::CanStop method.

The reason for stopping can be either CANSTOP_ENTRYPOINT, which means the DE has reached an entry point, or CANSTOP_STEPIN, which means the DE has stepped into a function.

See Also

Concepts

IDebugCanStopEvent2

CANSTOP_REASON

IDebugCanStopEvent2::CanStop