Expand Minimize

KeRegisterBugCheckCallback routine

The KeRegisterBugCheckCallback routine registers a BugCheckCallback routine, which executes when the operating system issues a bug check.

Syntax


BOOLEAN KeRegisterBugCheckCallback(
  _Out_     PKBUGCHECK_CALLBACK_RECORD CallbackRecord,
  _In_      PKBUGCHECK_CALLBACK_ROUTINE CallbackRoutine,
  _In_opt_  PVOID Buffer,
  _In_      ULONG Length,
  _In_      PUCHAR Component
);

Parameters

CallbackRecord [out]

Pointer to a callback record that was previously initialized by KeInitializeCallbackRecord, for which the caller provides nonpaged storage.

CallbackRoutine [in]

Pointer to the driver-supplied BugCheckCallback routine.

Buffer [in, optional]

Pointer to a caller-supplied buffer, which must be in resident memory, such as nonpaged pool.

Length [in]

Specifies the size in bytes of the caller-allocated buffer.

Component [in]

Pointer to a null-terminated ANSI string that identifies the caller. This string usually contains the name of the device driver, or possibly of its device.

Return value

KeRegisterBugCheckCallback returns TRUE if the caller-supplied routine is successfully added to the set of registered bug-check callbacks; otherwise, it returns FALSE.

Remarks

The KeRegisterBugCheckCallback routine registers a BugCheckCallback routine, the simplest kind of bug-check callback routine. To register other kinds of bug-check callbacks, such as BugCheckDumpIoCallback and BugCheckAddPagesCallback routines, use the KeRegisterBugCheckReasonCallback routine instead.

The BugCheckCallback routine is executed when the system issues a bug check. A driver can use the routine to reset the device to a known state. For more information, see BugCheckCallback.

Drivers can use the KeDeregisterBugCheckCallback routine to remove the callback. Any driver that can be unloaded must remove all of its callbacks in its Unload routine.

The Component string is used to identify the driver during crash-dump debugging. To display the crash dump data corresponding to any specified Component string, you can use the !bugdump debugger extension. It is also possible to debug the bug check callback routine itself. For information about debuggers and debugger extensions, see Windows Debugging.

Requirements

Version

Available starting with Windows 2000.

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

Library

Ntoskrnl.lib

IRQL

Any level

See also

KeDeregisterBugCheckCallback
KeInitializeCallbackRecord
KeRegisterBugCheckReasonCallback
BugCheckAddPagesCallback
BugCheckCallback
BugCheckDumpIoCallback

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft