InstallShield Custom Action Reference

InstallShield 2015

This section describes each of the built-in InstallShield custom actions that are added automatically to InstallShield projects to support different functionality.

_serial_verifyCA_isx

Decreases the value of the property SERIALNUMVALRETRYLIMIT by 1.

_serial_verifyCA_isx_helper

Decreases the value of the property SERIALNUMVALRETRYLIMIT by 1.

CheckForProductUpdates

Uses FlexNet Connect to check for product updates.

This custom action launches an executable file called Agent.exe, and it passes the following:

/au[ProductCode] /EndOfInstall

CheckForProductUpdatesOnReboot

Uses FlexNet Connect to check for product updates on reboot.

This custom action launches an executable file called Agent.exe, and it passes the following:

/au[ProductCode] /EndOfInstall /Reboot

DLLWrapCleanup

Standard DLL wrapper that cleans extracted data.

This is a Windows Installer DLL custom action. The name of the DLL file is dllwrap.dll, and its entry point is DLLWrapCleanup.

DLLWrapStartup

Standard DLL wrapper that extracts data that describes calls.

This is a DLL custom action. The name of the DLL file is dllwrap.dll, and its entry point is DLLWrapStartup.

ISChainPackageCommit

Removes extracted files from a multi-package transaction.

ISChainPackagePrepare

Prepares and extracts files for a multi-package transaction.

ISChainPackageRollback

Removes extracted files from a multi-package transaction.

ISComponentServiceCosting

Extracts information from the ISComPlusApplication table and saves it in a temporary file for COM+ applications.

This is a Windows Installer DLL custom action. The name of the DLL file is iscomsrv.dll, and its entry point is ISComponentServiceCosting.

ISComponentServiceFinalize

Commits COM+ applications during installation and uninstallation.

This is a Windows Installer DLL custom action. The name of the DLL file is iscomsrv.dll, and its entry point is ISComponentServiceFinalize.

ISComponentServiceInstall

Installs COM+ applications during an installation.

This is a DLL custom action. The name of the DLL file is iscomsrv.dll, and its entry point is ISComponentServiceInstall.

ISComponentServiceRollback

Rolls back COM+ applications during a failed installation or uninstallation.

This is a DLL custom action. The name of the DLL file is iscomsrv.dll, and its entry point is ISComponentServiceRollback.

ISComponentServiceUninstall

Removes COM+ applications during uninstallation.

This is a DLL custom action. The name of the DLL file is iscomsrv.dll, and its entry point is ISComponentServiceUninstall.

ISIISCleanup

Removes temporary files and registry entries for an IIS installation.

This is a DLL custom action. The name of the DLL file is IISHelper.dll, and its entry point is ISIISCleanup.

ISIISCosting

Creates a list of actions in a temporary file for an IIS installation. Sets the CustomActionData property for other IIS actions.

This is a DLL custom action. The name of the DLL file is IISHelper.dll, and its entry point is ISIISCosting.

ISIISInstall

Creates Web sites, applications, virtual directories, and other items for an IIS installation.

This is a DLL custom action. The name of the DLL file is IISHelper.dll, and its entry point is ISIISInstall.

ISIISRollback

Removes Web sites, applications, virtual directories, and other items during rollback for IIS.

This is a DLL custom action. The name of the DLL file is IISHelper.dll and its entry point is ISIISRollback.

ISIISUninstall

Removes Web sites, applications, virtual directories, and other items during uninstallation for IIS.

This is a DLL custom action. The name of the DLL file is IISHelper.dll, and its entry point is ISIISUninstall.

ISInstallPrerequisites

Launches the installation of prerequisites that are associated with features.

This is a DLL custom action. The name of the DLL file is PrqLaunch.dll, and its entry point is InstallPrerequisites.

ISJITCompileActionAtInstall

Precompiles .NET assemblies at installation time.

This custom action launches a Microsoft executable file called ngen.exe.

ISJITCompileActionAtUnInstall

Deletes a precompiled .NET assemblies at uninstallation time.

This custom action launches a Microsoft executable file called ngen.exe.

ISLockPermissionsCost

Sets the CustomActionData property for the ISLockPermissionsInstall action.

This is a DLL custom action. The name of the DLL file is ISLockPermissions.dll, and its entry point is ISLockPermissionsCostAction.

ISLockPermissionsInstall

Sets permissions when the product is installed.

This is a DLL custom action. The name of the DLL file is ISLockPermissions.dll, and its entry point is ISLockPermissionsInstallAction.

ISNetApiInstall

Creates users and groups from an .ini file.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetAPI.dll, and its entry point is ISNetApiInstall.

ISNetApiRollback

Rolls back changes for users and groups.

This is a DLL custom action. The name of the DLL file is ISNetAPI.dll, and its entry point is ISNetApiRollback.

ISNetCreateIniForOneUser

Extracts operations to a temporary file for users and groups.

This is a DLL custom action called ISNetAPI.dll.

ISNetDeleteIniFile

Cleans up temporary files for users and groups.

This is a DLL custom action called ISNetAPI.dll.

ISNetGetGroups

Puts groups into a combo box.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetAPI.dll, and its entry point is ISNetGetGroups.

ISNetGetServers

Puts a list of servers into a combo box.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetAPI.dll, and its entry point is ISNetGetServers.

ISNetGetUsers

Puts a list of users into a combo box.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetAPI.dll, and its entry point is ISNetGetUsers.

ISNetSetLogonName

Stores the user, group, and server properties that were entered in the LogonInformation dialogs.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetAPI.dll, and its entry point is ISNetSetLogonName.

ISNetValidateLogonName

Verifies that a valid user name, server, and password combination were entered in the LogonInformation dialogs.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetAPI.dll, and its entry point is ISNetValidateLogonName.

ISNetValidateNewUserInformation

Stores the user, group, and server properties that were entered in the LogonInformation dialogs.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetAPI.dll, and its entry point is ISNetValidateNewUserInformation.

ISNetworkSharesCosting

Extracts information from the ISNetworkShares table and saves it in a temporary file for network sharing.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetworkShares.dll, and its entry point is ISNetworkSharesCosting.

ISNetworkSharesFinalize

Cleans up temporary files for configuring network shares.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetworkShares.dll, and its entry point is ISNetworkSharesFinalize.

ISNetworkSharesInstall

Configures network sharing for one or more folders.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetworkShares.dll, and its entry point is ISNetworkSharesInstall.

ISNetworkSharesRollback

Rolls back network sharing for one or more folders.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetworkShares.dll, and its entry point is ISNetworkSharesRollback.

ISNetworkSharesUninstall

Removes network sharing for one or more folders.

This is a Windows Installer DLL custom action. The name of the DLL file is ISNetworkShares.dll, and its entry point is ISNetworkSharesUninstall.

ISPrint

Prints the contents of a ScrollableText control on a dialog.

This is a Windows Installer DLL custom action. The name of the DLL file is SetAllUsers.dll, and its entry point is PrintScrollableText.

ISQuickPatchFinalize

Cleans shared reference counts for a QuickPatch.

This is a Windows Installer DLL custom action. The name of the DLL file is QuickPatchHelper.dll, and its entry point is ISQuickPatchFinalize.

ISQuickPatchFixShortcut

Reinstalls shortcuts for a QuickPatch.

This is a Windows Installer DLL custom action. The name of the DLL file is QuickPatchHelper.dll, and its entry point is ISQuickPatchFixShortcut.

ISQuickPatchHelper

Applies clean feature states for a QuickPatch.

This is a Windows Installer DLL custom action. The name of the DLL file is QuickPatchHelper.dll, and its entry point is ISQuickPatchHelper.

ISQuickPatchInit

Cleans component and feature states for a QuickPatch.

This is a Windows Installer DLL custom action. The name of the DLL file is QuickPatchHelper.dll, and its entry point is ISQuickPatchInit.

ISQuickPatchInit9X

Cleans component and feature states for a QuickPatch.

This is a Windows Installer DLL custom action. The name of the DLL file is QuickPatchHelper.dll, and its entry point is ISQuickPatchInit9X.

ISQuickPatchInit9X2

Cleans component and feature states for a QuickPatch.

This is a Windows Installer DLL custom action. The name of the DLL file is QuickPatchHelper.dll, and its entry point is ISQuickPatchInit9X2.

ISRunSetupTypeAddLocalEvent

Runs the AddLocal events that are associated with the Next button on the SetupType dialog. This action needs to be called when the installation does not display the SetupType dialog.

This is a Windows Installer DLL custom action. The name of the DLL file is ISXExpHlp.dll, and its entry point is RunSetupTypeAddLocalEvent.

ISSearchReplaceCosting

Creates a temporary file that has a list of changes that need to be made in text files.

This is a DLL custom action. The name of the DLL file is isschrpl.dll, and its entry point is ISSearchReplaceCosting.

ISSearchReplaceFinalize

Cleans up temporary files for text file changes.

This is a DLL custom action. The name of the DLL file is isschrpl.dll, and its entry point is ISSearchReplaceFinalize.

ISSearchReplaceInstall

Applies text file changes when the product is installed.

This is a DLL custom action. The name of the DLL file is isschrpl.dll, and its entry point is ISSearchReplaceInstall.

ISSearchReplaceRollback

Rolls back text file changes and cleans up temporary files for text file changes.

This is a DLL custom action. The name of the DLL file is isschrpl.dll, and its entry point is ISSearchReplaceRollback.

ISSearchReplaceUninstall

Applies text file changes when the product is uninstalled.

This is a DLL custom action. The name of the DLL file is isschrpl.dll, and its entry point is ISSearchReplaceUninstall.

ISSelfRegisterCosting

Extracts operations to a temporary file for self-registration.

This is a Windows Installer DLL custom action. The name of the DLL file is isregsvr.dll, and its entry point is ISSelfRegisterCosting.

ISSelfRegisterFiles

Registers self-registering files.

This is a Windows Installer DLL custom action. The name of the DLL file is isregsvr.dll, and its entry point is ISSelfRegisterFiles.

ISSelfRegisterFinalize

Cleans up temporary file from self-registration.

This is a Windows Installer DLL custom action. The name of the DLL file is isregsvr.dll, and its entry point is ISSelfRegisterFinalize.

ISSetAllUsers

Sets ALLUSERS per upgrade or initial installation requirements.

This is a DLL custom action. The name of the DLL file is SetAllUsers.dll, and its entry point is SetAllUsers.

ISSetTARGETDIR

Sets TARGETDIR to [INSTALLDIR].

This is a DLL custom action. The name of the DLL file is SetAllUsers.dll, and its entry point is SetTARGETDIR.

ISSetupFilesCleanup

Cleans up the temp directory of support files.

This is a DLL custom action. The name of the DLL file is SFHelper.dll, and its entry point is SFCleanupEx.

ISSetupFilesExtract

Extracts support files to a temp directory.

This is a DLL custom action. The name of the DLL file is SFHelper.dll, and its entry point is SFStartupEx.

ISSQLQueryDatabases

Finds database catalogs that are available on a specified database server.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLQueryDatabases.

ISSQLServerCosting

Extracts operations to a temporary file for SQL scripts.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerCosting.

ISSQLServerFilteredList

Finds available servers for SQL scripts.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerFilteredList.

ISSQLServerFinalize

Cleans up temporary files and the state for SQL scripts.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerFinalize.

ISSQLServerInitialize

Adds property names for SQL login password to MsiHiddenProperties.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerInitialize.

ISSQLServerInstall

Runs SQL scripts during an installation.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerInstall.

ISSQLServerList

Finds available servers.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerList.

ISSQLServerRemoveLoginInfo

Removes SQL database login credentials from the Windows registry during an uninstallation.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerRemoveLoginInfo.

ISSQLServerRollback

Runs SQL scripts during a failed installation or uninstallation.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerRollback.

ISSQLServerRollbackLoginInfo

During a failed installation or uninstallation, rolls back SQL database login credentials that are stored in the Windows registry.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerRollbackLoginInfo.

ISSQLServerUninstall

Runs SQL scripts during an uninstallation.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerUninstall.

ISSQLServerValidate

Tests server connections.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerValidate.

ISSQLServerWriteLoginInfo

Writes SQL database login credentials to the Windows registry during an installation.

This is a DLL custom action. The name of the DLL file is issqlsrv.dll, and its entry point is ISSQLServerWriteLoginInfo.

ISUnSelfRegisterFiles

Unregisters self-registering files.

This is a DLL custom action. The name of the DLL file is isregsvr.dll, and its entry point is ISUnSelfRegisterFiles.

ISVerifyScriptingRuntime

Verifies that an InstallScript MSI installation was launched using Setup.exe, and if not, it displays the message contained in the property STANDARD_USE_SETUPEXE. This custom action is included in all InstallScript MSI projects, and it is scheduled for the beginning of the User Interface sequence.

Note: The ISVerifyScriptingRuntime custom action is called in an InstallScript MSI installation in which the InstallScript UI style is the traditional style (which uses the InstallScript engine as an external UI handler). It is not called for the new style (which uses the InstallScript engine as an embedded UI handler).

To learn more, see Using the InstallScript Engine as an External vs. Embedded UI Handler for InstallScript MSI Installations.

ISXmlAppSearch

Performs a system search for XML: finds file, performs XPath queries, and stores the results in properties. Driven by the ISXmlLocator table.

This is a DLL custom action. The name of the DLL file is isxmlcfg.dll, and its entry point is ISXmlAppSearch.

ISXmlCosting

Extracts operations to a temporary file for XML file changes.

This is a DLL custom action. The name of the DLL file is isxmlcfg.dll, and its entry point is ISXmlCosting.

ISXmlFinalize

Cleans up temporary files for XML file changes.

This is a DLL custom action. The name of the DLL file is isxmlcfg.dll, and its entry point is ISXmlFinalize.

ISXmlInstall

Applies XML file changes.

This is a DLL custom action. The name of the DLL file is isxmlcfg.dll, and its entry point is ISXmlInstall.

ISXmlRollback

Rolls back XML file changes.

This is a DLL custom action. The name of the DLL file is isxmlcfg.dll, and its entry point is ISXmlRollback.

ISXmlUnInstall

Uninstalls XML file changes.

This is a DLL custom action. The name of the DLL file is isxmlcfg.dll, and its entry point is ISXmlUnInstall.

LaunchProgramFileFromSetupCompleteSuccess

Launches an executable file at the end of an installation.

This is a Windows Installer DLL custom action. The name of the DLL file is SerialNumCAHelper.dll, and its entry point is LaunchProgram.

LaunchReadmeFileFromSetupCompleteSuccess

Launches a readme file at the end of an installation.

This is a Windows Installer DLL custom action. The name of the DLL file is SerialNumCAHelper.dll, and its entry point is LaunchReadMe.

setAllUsersProfile2K

Initializes the ALLUSERSPROFILE directory identifier for Windows 2000 or later.

SetAllUsersProfileNT

Initializes the ALLUSERSPROFILE directory identifier for Windows NT 4.

SetARPINSTALLLOCATION

Sets the value of the ARPINSTALLLOCATION property to the fully qualified path for the application’s primary folder.

setUserProfileNT

Initializes the USERPROFILE directory indentifier.

ShowMsiLog

Displays the Windows Installer log file in Notepad if the end user selects the Show the Windows Installer log check box in the SetupCompleteSuccess, SetupCompleteError, or SetupInterrupted dialogs and then clicks Finish. This works only with Windows Installer 4.0 and later.

WiseScriptFinalize

Cleans up temporary files for a WiseScript custom action.

This is a a DLL custom action. The name of the DLL file is WiseScriptBridge.dll, and its entry point is WiseScriptFinalize.

WiseScriptInitialize

Extracts required files for a WiseScript custom action.

This is a a DLL custom action. The name of the DLL file is WiseScriptBridge.dll, and its entry point is WiseScriptInitialize.

WiseScriptRollback

Cleans up temporary files for a WiseScript custom action.

This is a a DLL custom action. The name of the DLL file is WiseScriptBridge.dll, and its entry point is WiseScriptFinalize.

See Also