DbgPrint

DbgPrint sends a string to the kernel debugger.

ULONG
  DbgPrint(
    IN PCHAR  Format,
    . . . .  [arguments] 
    );

Parameters

Format

Specifies a pointer to the format string to print, as in printf. The Format string supports the printf-style formatting codes. However, the Unicode format codes (%C, %S, %lc, %ls, %wc, %ws, %wZ) can only be used at IRQL PASSIVE_LEVEL.

arguments

Specifies arguments for the format string, as in printf.

Return Value

If successful, DbgPrint returns the NTSTATUS code STATUS_SUCCESS; otherwise it returns the appropriate error code.

Headers

This routine is defined in ntddk.h, wdm.h, and ndis.h. Include ntddk.h, wdm.h, or ndis.h.

Comments

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

Only kernel-mode drivers can call the DbgPrint routine.

Unless it is absolutely necessary, you should not obtain a string from user input or another process and pass it to DbgPrint. If you do use a string that you did not create, you must verify that this is a valid format string, and that the format codes match the argument list in type and quantity. The best coding practice is for all Format strings to be static and defined at compile time.

The formatted string is sent to the DbgPrint Buffer. The contents of this buffer are displayed immediately in the Debugger Command window, unless this display has been disabled by using the Global Flags Editor (gflags.exe).

If this display has been disabled, the contents of the DbgPrint Buffer can only be viewed by using the !dbgprint extension command. For information on debugger extensions, see Debugging Tools for NT-Based Operating Systems.

There is no upper limit to the size of the Format string or the number of arguments. However, the DbgPrint buffer can only hold 512 bytes of information. Any output longer than this will be lost.

See Also

DbgPrintEx, KdPrint, KdPrintEx