DbgBreakPointWithStatus function (wdm.h)

Article
04/18/2022

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

Syntax

__analysis_noreturn NTSYSAPI VOID DbgBreakPointWithStatus(
  [in] ULONG Status
);

Parameters

[in] Status

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

Return value

None

Remarks

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

On x86 computers, 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 a debugger is not 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 bug check. You can, however, connect a kernel-mode debugger to a target computer that has stopped responding and has kernel debugging enabled. For more information, see Windows Debugging.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows 2000 and later.
Target Platform	Universal
Header	wdm.h (include Wdm.h, Ntddk.h)
Library	Ntdll.lib (user mode); NtosKrnl.lib (kernel mode)
DLL	NtosKrnl.exe
DDI compliance rules	DebugBreakUsage(wdm), HwStorPortProhibitedDDIs(storport)