EngCreateDriverObj function (winddi.h)

Article
02/22/2024

The EngCreateDriverObj function creates a DRIVEROBJ structure.

Syntax

ENGAPI HDRVOBJ EngCreateDriverObj(
  PVOID       pvObj,
  FREEOBJPROC pFreeObjProc,
  HDEV        hdev
);

Parameters

pvObj

Pointer to the driver resource that will be tracked by the DRIVEROBJ structure. The resource is associated with the current client process.

pFreeObjProc

Pointer to a driver-supplied callback function that frees the resource pointed to by pvObj. The callback function should be defined as follows, where pDriverObj points to the DRIVEROBJ structure:

BOOL CALLBACK DrvobjFreeObjProc(DRIVEROBJ *pDriverObj);

hdev

Handle to the physical device associated with the object. This parameter is the GDI handle received by the driver's DrvCompletePDEV function.

Return value

The return value is a handle that identifies the newly-created DRIVEROBJ structure if the function is successful. Otherwise, it is zero.

Remarks

This structure is used to track a device-managed resource that must be released if the resource-allocating process terminates without first cleaning it up.

The driver can explicitly delete the DRIVEROBJ structure by calling EngDeleteDriverObj. Otherwise, the engine frees the resource by calling the function pointed to by pFreeObjProc when the process that created the DRIVEROBJ terminates.

Requirements

Requirement	Value
Minimum supported client	Available in Windows 2000 and later versions of the Windows operating systems.
Target Platform	Universal
Header	winddi.h (include Winddi.h)
Library	Win32k.lib
DLL	Win32k.sys