SuiteReportError

InstallShield 2015 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
Suite/Advanced UI

Note: This function is available for InstallScript installations that may be included as InstallScript packages in an Advanced UI or Suite/Advanced UI installation. For more information, see Adding an InstallScript Package to an Advanced UI or Suite/Advanced UI Project.

This function returns an error in the following scenarios:

The function is called in an InstallScript installation that is launched directly (that is, not from an Advanced UI or Suite/Advanced UI installation).
The function is called in an InstallScript installation that is included in an Advanced UI or Suite/Advanced UI installation as an executable package.

The SuiteReportError function displays a message box in the Advanced UI or Suite/Advanced UI user interface to report an error that occurred as the Advanced UI or Suite/Advanced UI installation ran the InstallScript package.

Syntax

SuiteReportError (string szMessage, nFlags);

Parameters

SuiteReportError Parameters

Parameter

Description

szMessage

Specify the error message that you want to display for end users.

nFlags

Specify any valid MessageBox flags. For valid flags, see MessageBox Function on MSDN.

Return Values

SuiteReportError Return Values

Return Value

Description

ISERR_ISERVICE_NOT_ENABLED

The function was not called in an InstallScript package that was launched from an Advanced UI or Suite/Advanced UI installation. It was called in an InstallScript installation that was launched directly, or from an InstallScript installation that was included as an executable package in an Advanced UI or Suite/Advanced UI installation.

MessageBox Return Values

For possible return values, see MessageBox Function on MSDN.

See Also