InstallShield 2016 » 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 SuiteFormatString function resolves formatted expressions that contain property names, environment variable references, and other special strings. At run time, the Advanced UI or Suite/Advanced UI installation expands the values of these expressions. The function stores the resulting string in a string variable.
Syntax
SuiteFormatString (string szValue, string svFormattedValue);
Parameters
|
Parameter |
Description |
|
szValue |
Specify a string that includes one or more formatted expressions that contain property names, environment variable references, or other special strings. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time. |
|
svFormattedValue |
Specify the string variable that you want to contain the formatted string or expression. At run time, the installation expands the values of valid formatted expressions. Invalid expressions resolve to empty strings (""). |
Return Values
|
Return Value |
Description |
|
ISERR_SUCCESS |
The function successfully resolved the formatted expression. |
|
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
Suite/Advanced UI and Advanced UI Interaction Functions
Guidelines for Adding Packages to an Advanced UI or Suite/Advanced UI Project
InstallShield 2016 Help LibraryMay 2017 |
Copyright Information | Flexera Software |