SuiteSetProperty
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 SuiteSetProperty function sets the value of an Advanced UI or Suite/Advanced UI property in the Advanced UI or Suite/Advanced UI installation that launched the running InstallScript package, or the value of a Suite/Advanced UI property in the Suite/Advanced UI installation that launched the running InstallScript action.
Syntax
SuiteSetProperty (string szName, string szValue);
Parameters
|
Parameter |
Description |
|
szName |
Specify the name of the Advanced UI or Suite/Advanced UI property whose value you want to set. It supports feature properties also like FEATURE[name].actionState. |
|
szValue |
Specify the value of the Advanced UI or Suite/Advanced UI property that you want to set. |
Return Values
|
Return Value |
Description |
|
ISERR_SUCCESS |
The function successfully set the property 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. |