WdfDriverWdmGetDriverObject function (wdfdriver.h)

Article
02/22/2024

[Applies to KMDF only]

The WdfDriverWdmGetDriverObject method retrieves a pointer to the Windows Driver Model (WDM) driver object that is associated with a specified framework driver object.

Syntax

PDRIVER_OBJECT WdfDriverWdmGetDriverObject(
  [in] WDFDRIVER Driver
);

Parameters

[in] Driver

A handle to the driver's framework driver object that the driver obtained from a previous call to WdfDriverCreate or WdfGetDriver.

Return value

WdfDriverWdmGetDriverObject returns a pointer to a DRIVER_OBJECT structure. A system bug check occurs if the Driver handle is invalid.

Remarks

The pointer that the WdfDriverWdmGetDriverObject method returns is valid until the framework driver object is deleted. If the driver provides an EvtCleanupCallback function for the framework driver object, the pointer is valid until the callback function returns.

Examples

The following code example obtains a pointer to the WDM driver object that is associated with a specified framework driver object.

PDRIVER_OBJECT  pDrvObj;

pDrvObj = WdfDriverWdmGetDriverObject(Driver);

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.0
Header	wdfdriver.h (include Wdf.h)
Library	Wdf01000.sys (see Framework Library Versioning.)
IRQL	<= DISPATCH_LEVEL
DDI compliance rules	DriverCreate(kmdf)