KeRegisterBugCheckCallback

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

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

Parameters

CallbackRecord

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

CallbackRoutine

Pointer to the driver-supplied BugCheckCallback routine.

Buffer

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

Length

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

Component

Pointer to a zero-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.

Headers

Declared in ntddk.h. Include ntddk.h.

Comments

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 BugCheckSecondaryDumpDataCallback routines, see KeRegisterBugCheckReasonCallback.

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 given 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 Debugging Tools for NT-Based Operating Systems.

Callers of KeRegisterBugCheckCallback can be running at any IRQL.

See Also

KeDeregisterBugCheckCallback, KeInitializeCallbackRecord, KeRegisterBugCheckReasonCallback, BugCheckCallback, BugCheckDumpIoCallback, BugCheckSecondaryDumpDataCallback