WdfDriverWdmGetDriverObject function

[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(
  WDFDRIVER Driver
);

Parameters

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

   
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

See Also

DRIVER_OBJECT

WdfDriverCreate

WdfGetDriver