DIF_INSTALLDEVICE

Article
12/15/2021

A DIF_INSTALLDEVICE request allows an installer to perform tasks before and/or after the device is installed.

When Sent

After selecting the driver, registering any device co-installers, and registering any device interfaces.

Who Handles

Class Co-installer	Can handle
Device Co-installer	Can handle
Class Installer	Can handle

Installer Input

DeviceInfoSet
Supplies a handle to the device information set that contains the device to be installed.

DeviceInfoData
Supplies a pointer to an SP_DEVINFO_DATA structure for the device in the device information set.

Device Installation Parameters
There are device installation parameters (SP_DEVINSTALL_PARAMS) associated with the DeviceInfoData.

Class Installation Parameters
None

Installer Output

Device Installation Parameters
An installer can modify the device installation parameters for the DeviceInfoData. For example, an installer might set the DI_NEEDREBOOT flag or it might set the DI_DONOTCALLCONFIGMG flag to prevent Windows from bringing the device online dynamically with its newly installed driver and settings.

Installer Return Value

A co-installer typically returns NO_ERROR or ERROR_DI_POSTPROCESSING_REQUIRED. A co-installer might also return a Win32 error code.

If a class installer successfully handles this request and SetupDiCallClassInstaller should subsequently call the default handler, the class installer returns ERROR_DI_DO_DEFAULT.

If the class installer successfully handles this request, including directly calling the default handler, the class installer should return NO_ERROR and SetupDiCallClassInstaller will not subsequently call the default handler again.

Note The class installer can directly call the default handler, but the class installer should never attempt to supersede the operations of the default handler. For more information about calling a default DIF code handler, see Calling Default DIF Code Handlers.

If the class installer encounters an error, the installer should return an appropriate Win32 error code and SetupDiCallClassInstaller will not subsequently call the default handler.

Default DIF Code Handler

SetupDiInstallDevice

Installer Operation

In response to a DIF_INSTALLDEVICE request an installer typically performs any final installation operations before the default handler installs the device. For example, an installer can check, and possibly modify, the upper-filter drivers and lower-filter drivers for the device that is listed in the registry.

Unless the DI_NOFILECOPY flag is set in the device installation parameters, an installer that handles this DIF request should copy files that are required for the device, such as driver files and control panel files.

If the DI_NOFILECOPY flag is clear but the DI_NOVCP flag is set, the installer must enqueue any file operations to the supplied file queue but must not commit the queue.

A co-installer can handle this DIF request in its preprocessing pass and/or in its postprocessing pass. In its preprocessing pass, a co-installer performs any operations that must occur before Windows loads the drivers and starts the device.

In its postprocessing pass, the device is up and running unless the DI_NEEDREBOOT flag was set. If this flag is set, Windows could not bring the device online dynamically.

If the installer returns a Win32 error code, Windows abandons the installation.

If Windows cannot locate an INF file for a new device, it sends DIF_INSTALLDEVICE in an attempt to install a null driver. The default handler (SetupDiInstallDevice) checks whether the device either supports raw mode or is a non-PnP device (reported by IoReportDetectedDevice), In the latter case, Windows installs a null driver for the device.

If this attempt fails, Windows sends DIF_INSTALLDEVICE again, this time with the DI_FLAGSEX_SETFAILEDINSTALL flag set in the SP_DEVINSTALL_PARAMS structure. In this case, the default handler just sets the FAILEDINSTALL flag in the device's ConfigFlags registry value. If the DI_FLAGSEX_SETFAILEDINSTALL flag is set, class installers must return NO_ERROR or ERROR_DI_DO_DEFAULT and co-installers must return NO_ERROR.

For more information about DIF codes, see Handling DIF Codes.

Calling the Default Handler SetupDiInstallDevice

For general information about when and how to call a SetupDiInstallDevice, see Calling Default DIF Code Handlers.

In the rare situation where the class installer must perform operations after all SetupDiInstallDevice operations, except for starting a device, have completed, the class installer must:

Perform operations that must be done before calling SetupDiInstallDevice.
Set the DI_DONOTCALLCONFIGMGR flag in the SP_DEVINSTALL_PARAMS.Flags member for the device. If this flag is set, SetupDiInstallDevice performs all default installation operations except for starting the device.
Call SetupDiInstallDevice to perform all default installation operations except for starting the device.
Perform the operations that must be done after all default installation operations, except for starting the device, have completed.
Call SetupDiRestartDevices to start the device.
Return NO_ERROR if the class installer successfully completed the installation operation or return a Win32 error if the installation operation failed.

Requirements

Version	Supported in Microsoft Windows 2000 and later versions of Windows.
Header	Setupapi.h (include Setupapi.h)