DbgBreakPointWithStatus

DbgBreakPointWithStatus breaks into the kernel debugger and sends the value of Status to the debugger.

NTSYSAPI
VOID
NTAPI
  DbgBreakPointWithStatus(
    IN ULONG  Status
    );

Parameters

Status

Specifies a ULONG value to be sent to the debugger (for example, a status code or an address).

Headers

This routine is defined in ntddk.h. Include ntddk.h.

Comments

This routine can only be used in Windows 2000 and later.

DbgBreakPointWithStatus is identical to DbgBreakPoint, except for the Status message.

On x86 machines, the Status parameter is stored in the eax register. On machines that have register calling conventions, Status is stored in the first argument register.

This routine raises an exception that is handled by the kernel debugger if one is installed; otherwise it is handled by the debug system. If no debugger is connected to the system, the exception can be handled in the standard way.

In kernel mode, a break exception that is not handled will cause a blue screen (bug check) to result. You can, however, connect a kernel-mode debugger to a hung target computer that has kernel debugging enabled. For more information, see Debugging Tools for NT-Based Operating Systems.

See Also

DbgBreakPoint, KdBreakPoint, KdBreakPointWithStatus