Custom Action Return Values

InstallShield 2016

Project • This information applies to the following project types:

•

Basic MSI

•

DIM

•

InstallScript MSI

•

Merge Module

•

MSI Database

•

MSM Database

•

Transform

Depending on your selections in the Custom Action Wizard’s Additional Options panel, Windows Installer will wait for a successful return code before continuing with the installation. Your custom action must return one of these values according to its status.

Custom Action Return Values
Return Value	Description
ERROR_FUNCTION_NOT_CALLED	The custom action was not executed.
ERROR_INSTALL_FAILURE	The custom action failed.
ERROR_INSTALL_SUSPEND	The custom action was suspended, but it will be resumed later.
ERROR_INSTALL_USEREXIT	The custom action could not complete successfully because the end user aborted it.
ERROR_NO_MORE_ITEMS	The custom action succeeded, but the remaining actions should be skipped.
ERROR_SUCCESS	The custom action succeeded.

If you are authoring an InstallScript custom action, your entry-point function can return either ERROR_SUCCESS or ERROR_INSTALL_FAILURE. These constants are defined for you when you include Iswi.h in your script. The InstallScript engine reports any of the other exceptions to Windows Installer.

Open topic with navigation

Custom Action Return Values

InstallShield 2016 Help Library

August 2016