Setting DPInst Configuration Flags

DPInst supports configuration flags that you can use to customize the operation of DPInst. By default, the configuration flags are set to OFF. In most situations, you can set a configuration flag to ON by including a corresponding DPInst XML element in a DPInst descriptor file. Alternatively, you can set any of the configuration flag to ON by using a corresponding DPInst command-line switch.

The following table lists the configuration flags that DPInst supports.

FlagUse

deleteBinaries

When a driver package is uninstalled, delete the binary files that were copied to a system when the driver package was installed.

Note   Starting with Windows 7, the operating system ignores the deleteBinaries flag. Binary files, which were copied to a system when a driver package was installed, can no longer be deleted by using DPInst.

enableNotListedLanguages

Enable all of the supported languages that are not explicitly enabled by a language XML element in a DPInst.xml file.

forceIfDriverIsNotBetter

Force DPInst to install a driver on device even if the driver is not a better match than the driver that is currently installed on the device

legacyMode

Install unsigned driver packages and driver packages that have missing files.

installAllOrNone

Install driver packages in an installation package only if all of the drivers in the installation package can be installed.

promptIfDriverIsNotBetter

Display a user dialog box that informs the user that a new driver is not a better match to a device than the driver that is currently installed on the device, and give the user the option to replace the currently installed driver with the new driver.

quietInstall

Suppress the display of user interface items that DPInst and Windows generate.

scanHardware

Install a driver package for a Plug and Play (PnP) function driver only if the driver package matches a device that is configured in a computer and the driver package is a better match for the device than the driver package that is currently installed on the device.

suppressAddRemovePrograms

Suppress the addition of entries to Programs and Features in Control Panel. These entries represent the driver packages that DPInst installs.

Note  In versions of Windows earlier than Windows Vista, DPInst added the entry for the driver package to Add or Remove Programs in Control Panel.

suppressEulaPage

Suppress the display of an end-user license agreement (EULA) page.

suppressWizard

Suppress the display of wizard pages and other user messages that DPInst generates.

 

Setting the deleteBinaries Flag

By default, when DPInst uninstalls a driver package, DPInst does not delete the binary files that were copied to the system when the driver package was installed. If you set the deleteBinaries flag to ON, DPInst will delete these binary files from a system. DPInst deletes a binary file from the system only if the binary file is identical to the corresponding binary file in the DIFx driver store. Use this flag with caution because DPInst cannot determine whether a binary file in the system is required by any other driver package or application.

By default, the deleteBinaries flag is set to OFF. You can set this flag to ON by including a deleteBinaries XML element as a child element of a dpinst XML element in a DPInst descriptor file or by using the /d DPInst command-line switch.

Note   Starting with Windows 7, the operating system ignores a setting of ON for the deleteBinaries flag. Binary files, which were copied to a system when a driver package was installed, can no longer be deleted by using DPInst.

Setting the enableNotListedLanguages Flag

By default, all of the languages that the multi-language version of DPInst supports are enabled. However, if you include language elements in a DPInst descriptor file, all of the languages that are not explicitly specified by language elements are disabled. This behavior supports driver packages that should be installed for use only with specific languages.

To enable all of the languages that are not explicitly enabled by language elements in a DPInst.xml file, set the enableNotListedLanguages flag to ON by including an enableNotListedLanguages XML element as a child element of a dpinst XML element in a DPInst.xml file or by using the /el DPInst command-line switch.

Setting the forceIfDriverIsNotBetter Flag

By default, DPInst installs a driver on a device only if the new driver is a better match to the device than the driver that is currently installed on the device. If you set the forceIfDriverIsNotBetter flag to ON, DPInst will install a driver on the device even if the driver is not a better match than the driver that is currently installed on the device.

By default, the forceIfDriverIsNotBetter flag is set to OFF. You can set the forceIfDriverIsNotBetter flag to ON by including a forceIfDriverIsNotBetter XML element as a child element of a dpinst XML element in a DPInst descriptor file or by using the /f DPInst command-line switch.

Setting the installAllOrNone Flag

By default, DPInst installs all of the driver packages that can be installed. If some driver packages cannot be installed, DPInst informs the user on the DPInst finish page which driver packages were installed and which drivers could not be installed. You can use the installAllOrNone flag to configure DPInst to install all of the driver packages only if all of the driver packages can be installed. This flag can also be used to configure DPInst to install the driver packages in a specific driver package group only if all of the driver packages in the driver package group can be installed.

By default, the installAllOrNone flag is set to OFF for all of the driver packages and driver package groups. To set the installAllOrNone flag to ON for all of the driver packages, including those in driver package groups, include a installAllOrNone XML element as a child element of a dpinst XML element in a DPInst descriptor file, or use the /a DPInst command-line switch. To set the installAllOrNone flag to ON for only a driver package group, include an installAllOrNone element as a child element of the corresponding group XML element.

Setting the legacyMode Flag

By default, DPInst installs a driver package only if the driver package has a Microsoft Windows Hardware Quality Labs (WHQL) signature or a Microsoft Authenticode signature. If you set the legacyMode flag to ON, DPInst operates in legacy mode. In legacy mode, DPInst accepts unsigned driver packages without performing signature verification. However, be aware that Windows driver signing requirements apply to the installation of a driver package from the DIFx driver store. These requirements depend on the Windows version, the signature type, the driver package type, and the driver signing options that are set for a computer.

If the legacyMode flag is set to ON, DPInst will also install a driver package that has missing files.

By default, the legacyMode flag is set to OFF. To set the legacyMode flag to ON, include the legacyMode XML element as child element of a dpinst XML element in a DPInst descriptor file, or use the /lm DPInst command-line switch.

Setting the promptIfDriverIsNotBetter Flag

By default, DPInst installs a new driver on a device only if the match between the new driver and the device is better than the match between the device and the driver that is currently installed on the device. DPInst does not inform a user that the new driver is not a better match to the device than the driver that is currently installed on the device.

You can set the promptIfDriverIsNotBetter flag to ON to configure DPInst to display a user dialog box if a new driver is not a better match to a device than the driver that is currently installed on the device. The user dialog box informs the user of this situation and gives the user the option to replace the currently installed driver with the new driver. DPInst does not display this message if the quietInstall flag is set to ON.

By default, the promptIfDriverIsNotBetter flag is set to OFF. You can set this flag to ON by including a promptIfDriverIsNotBetter XML element as a child element of a dpinst XML element in a DPInst descriptor file or by using the /p DPInst command-line switch.

Setting the quietInstall Flag

By default, DPInst displays all of the wizard pages, user dialog boxes, and other user messages that DPInst and Windows generate. If you set the quietInstall flag to ON, DPInst operates in quiet-install mode, which suppresses the display of the user interface items that DPInst and Windows generate. You should run DPInst in quiet-install mode only in situations where no user interaction is potentially required to complete an installation. Two typical situations that require user interaction are if Windows prompts a user before installing an unsigned driver package or if Windows prompts a user for the location of missing files.

If DPInst is running in quiet-install mode and Windows requires a user interaction to complete an installation, the installation will fail. The DPInst return code provides information about the status of the driver installation, including whether an installation failed or whether a system restart is required. In addition, if the installation failed, the DPInst log will include an entry that indicates the installation failed. However, the log will not indicate the installation failed because a user interaction was required.

The quietInstall flag works with the presence of an end-user license agreement (EULA) page and the suppressEulaPage flag.

If DPInst is working in quiet-install mode, you can configure DPInst to install a driver on a device (even if the driver that is currently installed on the device is a better match than the new driver) by setting the forceIfDriverIsNotBetter flag to ON.

If a system restart is required to complete the installation of a driver, DPInst does not display a dialog box that informs the user that a system restart is required. However, when the installation completes, DPInst returns a return code to the application that called it. The return code provides information about the status of the driver installation, including whether a system restart is required.

By default, the quietInstall flag is set to OFF. You can set the quietInstall flag to ON by including a quietInstall XML element as a child element of a dpinst XML element in a DPInst descriptor file or by using the /q DPInst command-line switch.

Setting the scanHardware Flag

By default, DPInst preinstalls a driver package for a Plug and Play (PnP) function driver, even if the driver package matches a device that is currently configured in a computer. If you set the scanHardware flag to ON, DPInst will install a driver package for a PnP function driver only if the driver package matches a device that is currently configured in a computer and the driver package is a better match for the device than the driver package that is currently installed on the device.

The scanHardware flag facilitates batch installing driver packages for devices that are configured in a computer. Although an installation package might contain a large number of driver packages, DPInst will install only those driver packages that are better matches for the devices than the driver packages that are currently installed on the devices.

By default, the scanHardware flag is set to OFF. You can set this flag to ON by including a scanHardware XML element as a child element of a dpinst XML element in a DPInst descriptor file or by using the /sh DPInst command-line switch.

Setting the suppressAddRemovePrograms Flag

By default, for driver packages that are not part of driver package group, DPInst adds an entry to Programs and Features in Control Panel. This entry represents each driver that it installs. DPInst also adds an entry to Programs and Features that represents each driver package group that it installs.

Note  In versions of Windows earlier than Windows Vista, DPInst added the entry for the driver package or driver package group to Add or Remove Programs in Control Panel.

To suppress creating Programs and Features entries, set the suppressAddRemovePrograms flag to ON for all of the driver packages and driver package groups or selectively set the flag only for specific driver package groups.

The suppressAddRemovePrograms flag is provided primarily to support those situations where a user should not be provided the option to remove a driver because Windows, or applications that are associated with the driver, cannot operate correctly without the driver installed.

By default, the suppressAddRemovePrograms flag is set to OFF for all of the driver packages and driver package groups. To set the suppressAddRemovePrograms flag to ON for all of the driver packages and driver packages groups, include a suppressAddRemovePrograms XML element as a child element of a dpinst XML element in a DPInst descriptor file, or use the /sa DPInst command-line switch. To set the suppressAddRemovedPrograms flag to ON only for a driver package group, include a suppressAddRemovePrograms element as a child element of the corresponding group XML element.

Setting the suppressEulaPage Flag

The suppressEulaPage flag works with the quietInstall flag or the suppressWizard flag as follows:

  • If a DPInst descriptor file includes a eula XML element and the suppressEulaPage flag is set to OFF, DPInst and Windows display wizard pages, user dialog boxes, and other user messages, even if you configure DPInst to operate in quiet-install mode (that is, the quietInstall flag is set to ON) or suppress-wizard mode (that is, the suppressWizard flag is set to ON).

  • If DPInst is configured to operate in quiet-install mode and a DPInst descriptor file does not include a eula element or the suppressEulaPage flag is set ON, DPInst suppresses the display of all user interface items that DPInst and Windows generate. For example, DPInst does not display the following items: the dialog box that informs a user that an installed driver is a better match than the one DPInst is installing, the dialog box that informs a user that a driver is unsigned, or the dialog box that informs a user that a system restart is required to complete the installation.

  • If DPinst is configured to operate in suppress-wizard mode and a DPInst descriptor file does not include a eula element or the suppressEulaPage flag is set ON, DPInst suppresses the user interface items that DPInst generates, but DPInst does not suppress the user interface items that Windows generates.

By default, the suppressEulaPage flag is set to OFF. You can set the suppressEulaPage flag to ON by using the /se DPInst command-line switch.

Setting the suppressWizard Flag

By default, DPInst displays all of the wizard pages and other user messages that DPInst generates during an installation. If you set the suppressWizard flag to ON, DPInst operates in suppress-wizard mode, which suppress the display of the wizard pages and other user messages that DPInst generates.

Be aware that suppress-wizard mode does not suppress user interface items that Windows generates. For more information about suppressing wizard pages, user dialog boxes, and other user messages that DPInst and Windows generate, see Setting the quietInstall Flag.

The suppressWizard flag works with the presence of an end-user license agreement (EULA) page and the suppressEulaPage flag.

By default, the suppressWizard flag is set to OFF. You can set the suppressWizard flag to ON by including a suppressWizard XML element as a child element of a dpinst XML element in a DPInst descriptor file or by using the /sw DPInst command-line switch.

The suppress-wizard mode is provided primarily to support installing non-WHQL class driver packages on Windows Server 2003. In particular, suppress-wizard mode can be used to perform a quiet installation of a non-WHQL class driver package that includes a device co-installer and has an Authenticode signature. DPInst will install such a driver package in suppress-wizard mode without displaying any wizard pages or user messages.

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft