![]()
|
InstallShield 2008 ยป InstallScript Language Reference
The InstallationInfo function is supported only for compatibility with scripts created in previous versions of InstallShield. We recommend that you use the CreateInstallationInfo function instead.
The InstallationInfo function specifies a company name, a product name, a product version number, and an application executable file name. The information you specify is used to create an application information key and a per application paths key for the program you are installing. The application information key is created immediately as a result of calling InstallationInfo. The per application paths key is not created until a subsequent call to RegDBSetItem sets a [Path] or [DefaultPath] value under that key.
InstallationInfo provides the product name for display in the Welcome dialog. It also provides the company name, product name, and version number that DeinstallStart uses to initialize the uninstallation log file. DeinstallStart will fail if InstallationInfo is not called before it in the script.
Call InstallationInfo only once in a setup. If you are launching multiple installations using DoInstall, each installation can of course have its own call to InstallationInfo.
InstallationInfo is a special registry-related function, designed to work with certain predefined registry keys. For more information on special registry-related functions, see Special Registry-Related Functions.
InstallationInfo (szCompany, szProduct, szVersion, szProductKey);
| Parameter |
Description |
|---|---|
| szCompany |
Specifies the company name. InstallShield uses szCompany to create a \<company> key under the <root key>\Software key in the registry. The root key is HKEY_CURRENT_USER if the ALLUSERS system variable is FALSE or you have called ProgDefGroupType(PERSONAL), or HKEY_LOCAL_MACHINE otherwise. |
| szProduct |
Specifies the name of the product to be installed. InstallShield uses szProduct to create a \<product> key under the <root key>\Software\<company> key in the registry. (The root key is HKEY_CURRENT_USER if the ALLUSERS system variable is FALSE or you have called ProgDefGroupType(PERSONAL), or HKEY_LOCAL_MACHINE otherwise.) The value in szProduct is also inserted into the first paragraph of message text in the Welcome dialog. |
| szVersion |
Specifies the version number of the product. InstallShield uses szVersion to create a \<version> key under the <root key>\Software\<company>\<product> key in the registry. (The root key is HKEY_CURRENT_USER if the ALLUSERS system variable is FALSE or you have called ProgDefGroupType(PERSONAL), or HKEY_LOCAL_MACHINE otherwise.) Together, the \<company> key (szCompany), the \<product> key (szProduct), and the \<version> key (szVersion) are referred to as the application information key. The application information key is created immediately upon calling InstallationInfo. |
| szProductKey |
Specifies the name of the application's main executable file. If your product uses several executables, specify the executable that best represents the product. InstallShield uses szProductKey to create a per application paths key under the key <root key>\Software\Microsoft\Windows\CurrentVersion\App Paths. (The root key is HKEY_CURRENT_USER if the ALLUSERS system variable is FALSE or you have called ProgDefGroupType(PERSONAL), or HKEY_LOCAL_MACHINE otherwise.) The per application paths key is not actually created in the registry until you call RegDBSetItem to create a value name and value pair under the key. |
| Return Value |
Description |
|---|---|
| 0 |
Indicates that the function was successful. |
| < 0 |
Indicates that the function was unable to use the parameters as set. Verify that you used proper syntax. Null string ()s are not allowed in any parameter within this function. You can obtain the error message text associated with a large negative return valuefor example, -2147024891 (0x80070005)by calling FormatMessage. |
You must call InstallationInfo before calling any of the following functions, which use the information provided by InstallationInfo: RegDBSetAppInfo, RegDBGetAppInfo, RegDBSetItem, RegDBGetItem. See the descriptions of those functions for further information.
The per application paths key specified by the values passed to InstallationInfo is not actually created until RegDBSetItem is called to set a value under that key.
See Also
|
|
Copyright Information | Contact Macrovision |