SuiteResolveString

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 SuiteResolveString function replaces an Advanced UI or Suite/Advanced UI string identifier with its corresponding string value in the InstallScript package that is running in an Advanced UI or Suite/Advanced UI installation, or in the InstallScript action that is running in a Suite/Advanced UI installation.

Syntax

SuiteResolveString (string szStringID, string svResolvedString);

Parameters

SuiteResolveString Parameters

Parameter

Description

szStringID

Specify the Advanced UI or Suite/Advanced UI string identifier that you want to be replaced.

svResolvedString

Specify the string variable that you want to store the value of the Advanced UI or Suite/Advanced UI string identifier; the value is based on the Advanced UI or Suite/Advanced UI installation’s selected language. An unknown string identifier returns an empty string ("").

Return Values

SuiteResolveString Return Values

Return Value

Description

ISERR_SUCCESS

The function successfully replaced the string identifier with the corresponding string value.

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