DEBUG_STATUS_XXX

The DEBUG_STATUS_XXX status codes have two purposes. They instruct the engine on how execution in the target should proceed, and they are used by the engine to report the execution status of the target.

After an event occurs, the engine can receive several instructions that tell it how execution in the target should proceed. In this case, it acts on the instruction with the highest precedence. Typically, the higher precedence status codes represent less execution for the target.

The values in the following table are reverse ordered by precedence; the values that appear earlier in the table have higher precedence.

Status Code When reporting When instructing Precedence

DEBUG_STATUS_NO_DEBUGGEE

No debugging session is active.

N/A

DEBUG_STATUS_OUT_OF_SYNC

The debugger communications channel is out of sync.

N/A

DEBUG_STATUS_WAIT_INPUT

The target is awaiting input from the user.

N/A

DEBUG_STATUS_TIMEOUT

The debugger communications channel has timed out.

N/A

DEBUG_STATUS_BREAK

The target is suspended.

Suspend the target.

Highest precedence

DEBUG_STATUS_STEP_INTO

The target is executing a single instruction.

Continue execution of the target for a single instruction.

DEBUG_STATUS_STEP_BRANCH

The target is executing until the next branch instruction.

Continue execution of the target until the next branch instruction.

DEBUG_STATUS_STEP_OVER

The target is executing a single instruction or--if that instruction is a subroutine call--subroutine.

Continue execution of the target for a single instruction. If the instruction is a subroutine call, the call is entered and the target is allowed to run until the subroutine returns.

DEBUG_STATUS_GO_NOT_HANDLED

N/A

Continue execution of the target, flagging the event as not handled.

DEBUG_STATUS_GO_HANDLED

N/A

Continue execution of the target, flagging the event as handled.

DEBUG_STATUS_GO

The target is executing normally.

Continue normal execution of the target.

DEBUG_STATUS_IGNORE_EVENT

N/A

Continue previous execution of the target, ignoring the event.

DEBUG_STATUS_RESTART_REQUESTED

The target is restarting.

Restart the target.

DEBUG_STATUS_NO_CHANGE

N/A

No instruction. This value is returned by an event callback method when it does not wish to instruct the engine how to proceed with execution in the target.

Lowest precedence

Note

The precedence of the status codes does not follow the numeric values of the constants.

Requirements

Header

DbgEng.h (include DbgEng.h)