SuiteLogInfo

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 is also available for InstallScript actions that are included in Suite/Advanced UI installations. For more information, see Working with an Action that Runs InstallScript Code in a Suite/Advanced UI Installation.

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 SuiteLogInfo function logs information about the InstallScript package that is running in an Advanced UI or Suite/Advanced UI installation to the Advanced UI or Suite/Advanced UI debug log. It also logs information about the InstallScript action that is running in a Suite/Advanced UI installation to the Suite/Advanced UI debug log.

For information about generating an Advanced UI or Suite/Advanced UI debug log, see Troubleshooting Issues with an Advanced UI or Suite/Advanced UI Installation.

Syntax

SuiteLogInfo (string szFormat, arglist);

Parameters

SuiteLogInfo Parameters

Parameter

Description

szFormat

Specify a standard printf-style format string to be rendered and written to the Advanced UI or Suite/Advanced UI installation's debug log.

arglist

Specify one or more arguments that correspond with the same number of format specifiers in szFormat.

Return Values

SuiteLogInfo Return Values

Return Value

Description

ISERR_SUCCESS

The function successfully logged information.

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, or from an InstallScript action in a 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.

See Also