WdfVerifierDbgBreakPoint function (wdfverifier.h)

Article
02/22/2024

[Applies to KMDF and UMDF]

The WdfVerifierDbgBreakPoint function breaks into a kernel debugger, if a debugger is running.

Syntax

void WdfVerifierDbgBreakPoint();

Return value

None

Remarks

The WdfVerifierDbgBreakPoint function breaks into a kernel debugger if one of the following is true:

DbgBreakOnError is set to a non-zero value in the registry.
VerifierOn is set to a non-zero value and DbgBreakOnError is not set.
Driver Verifier is enabled, the driver was built with framework version 1.9 or later, and neither VerifierOn nor DbgBreakOnError is set.

For more information about registry entries that you can use to debug your driver, see Registry Entries for Debugging Framework-Based Drivers.

For more information about debugging your driver, see Debugging a KMDF Driver.

Examples

The following code example shows how a driver might handle a failure to obtain an I/O request's output buffer.

Status = WdfRequestRetrieveOutputMemory(
                                        Request,
                                        &memory
                                        );
if( !NT_SUCCESS(Status) ) {
    KdPrint(("EvtIoRead could not get request memory buffer. Status: 0x%x\n",Status));
    WdfVerifierDbgBreakPoint();
    WdfRequestCompleteWithInformation(
                                      Request,
                                      Status,
                                      0L
                                      );
    return;
}

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	wdfverifier.h (include Wdf.h)
Library	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
IRQL	Any level
DDI compliance rules	DriverCreate(kmdf)