Installs (or upgrades) the product's system drivers and/or helper DLL.
def install(cab_file_name: str, product_guid: str, path_to_install: str, modules_to_install: int, flags: int) -> int: ...
This method is used to install or upgrade the product's various modules (i.e., the system drivers and Helper DLL). The ModulesToInstall parameter selects which modules should be installed. If the system must be rebooted to complete the installation process, this method will return a non-zero value indicating which module(s) requested the reboot (out of those initially selected).
Important: To upgrade the product's modules, just use the on_install method, do not uninstall them first!
Please refer to the Driver Installation topic for more information.
CabFileName must be the path of the .cab file containing the product modules. Important: This .cab file must remain on the target system (or be available in some other way) after installation, as it is required for uninstalling the modules from the system.
ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.
Therefore, to ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:
PathToInstall controls where the modules are installed. Pass empty string (highly recommended) to automatically install them to the appropriate Windows system directory.
ModulesToInstall should contain one or more of the following flags, OR'd together:
|MODULE_PNP_BUS||0x00000001||PnP Bus Driver (.sys file).
This module must be installed if the application wishes to make use of Plug-and-Play (PnP) storage features. PnP storage devices are those visible as disks in the Device Manager, and the system treats such storage devices differently from other purely virtual devices.
The filesystem driver must be re-installed anytime this module is added or removed.
|MODULE_DRIVER||0x00000002||Core Product Driver (.sys file).
The product's filesystem driver module provides the core of its functionality; it must be installed for the product to function correctly.
|MODULE_HELPER_DLL||0x00010000||Shell Helper DLL (CBFSShellHelper20.dll)
This module provides supplementary functionality; please refer to the Helper DLL topic for more information.
Note: Not applicable when calling the get_driver_status method.
Flags specifies various installation options, and should contain zero or more of the following flags, OR'd together:
|INSTALL_REMOVE_OLD_VERSIONS||0x00000001||Uninstall drivers and helper DLLs from previous class versions (e.g., 2017).|
|INSTALL_KEEP_START_TYPE||0x00000002||Keep the driver's current start type setting in the registry.
If this flag is not set (default), the installation logic will reset the driver's start type setting in the Windows registry to the default value. Setting this flag causes the installation logic to preserve the current value, which may be necessary if the user (or the application itself) set it previously.
|INSTALL_OVERWRITE_SAME_VERSION||0x00000004||Install files when their version is the same as the version of already installed files.
If this flag is not set (default), the installation logic will overwrite the existing file only if the version number of the file being installed is larger than the version of the file being overwritten. Setting this flag causes the installation logic to overwrite the file even when it has the same version.
This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.
This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD (0x0522) error.
Note: This method cannot be called within events.