DrvDriverEvent function (winddiui.h)

Article
03/13/2023

The print spooler calls a printer interface DLL's DrvDriverEvent function when the spooler processes driver-specific events that might require action by the printer driver.

Syntax

BOOL DrvDriverEvent(
                 DWORD  dwDriverEvent,
                 DWORD  dwLevel,
  [in, optional] LPBYTE pDriverInfo,
                 LPARAM lParam
);

Parameters

dwDriverEvent

Caller-supplied bit flag indicating the event that has occurred. Valid flags are listed in the following table.

Flag	Definition
DRIVER_EVENT_DELETE	The driver is being removed.
DRIVER_EVENT_INITIALIZE	The driver has just been installed.

dwLevel

Caller-supplied value indicating the type of structure pointed to by the pDriverInfo parameter, as indicated in the following table.

dwLevel Value	Structure pointed to by pDriverInfo
1	DRIVER_INFO_1
2	DRIVER_INFO_2
3	DRIVER_INFO_3

The DRIVER_INFO_N structures are described in the Microsoft Windows SDK documentation.

[in, optional] pDriverInfo

Caller-supplied pointer to a structure whose type is identified by the dwLevel parameter.

lParam

Caller-supplied flags. See the following Remarks section.

Return value

If the operation succeeds, the function should return TRUE. Otherwise, it should return FALSE.

Remarks

The optional DrvDriverEvent function is called by the spooler's AddPrinterDriverEx and DeletePrinterDriverEx functions, which are described in the Windows SDK documentation.

The function's purpose is to allow a printer driver's printer interface DLL to perform operations needed when the driver is installed or removed. A typical operation for this function to perform is to create or remove extra driver-specific files that are not specified as dependent files in a printer INF file.

If dwDriverEvent is DRIVER_EVENT_DELETE, the lparam parameter contains the flags that were specified for the DeletePrinterDriverEx function's dwDeleteFlag parameter. The lparam parameter is not used if dwDriverEvent is DRIVER_EVENT_INITIALIZE.

Because the DrvDriverEvent function is called in the context of the print spooler, it cannot display a user interface.

Requirements

Requirement	Value
Target Platform	Desktop
Header	winddiui.h (include Winddiui.h)

Share via