IDebugControl::GetInterrupt method

The GetInterrupt method checks whether a user interrupt was issued.

Syntax


HRESULT GetInterrupt();

Parameters

This method has no parameters.

Return value

Return codeDescription
S_OK

The method was successful and an interrupt has been requested.

S_FALSE

The method was successful and an interrupt was not requested.

 

This method may also return error values. See Return Values for more details.

Remarks

If a user interrupt was issued, it is cleared when this method is called.

Examples of user interrupts include pressing Ctrl+C or pressing the Stop button in a debugger. Calling SetInterrupt also causes a user interrupt.

Note   It is recommended that debugger extensions call GetInterrupt while undertaking long tasks.
 

This method can be called at any time and from any thread.

Requirements

Target platform

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugControl
IDebugControl2
IDebugControl3
SetInterrupt

 

 

Send comments about this topic to Microsoft

Show: