Job_InstallationStart
Description
Section titled “Description”Starts the installation part of a script. Call it after the pre-checks and before the installation steps. What the end user sees depends on the installation mode:
| Installation mode | Behavior |
|---|---|
| Silent | No message is shown, and the user isn’t logged off. |
| Attended | A message tells the user that the installation of sMsg has started, with the start time and the estimated time. |
| Logoff | If a user is logged on, the user is asked to log off. If the user clicks Cancel, the job is canceled and runs again at the next agent run. In computer jobs, a logon message tells users that an installation is running until Job_InstallationCompleted is called. |
If the script allows the end user to postpone the installation with CMS_DefineEndUserCancellation, the user is asked here. This also happens in silent installation mode.
The message texts come from the language set with Job_SetLanguage. The default is English.
In computer install jobs, the function also downloads the package’s kit file, if the package has one and it wasn’t downloaded yet.
Syntax
Section titled “Syntax”Job_InstallationStart(sMsg, sEstimatedTime, iInterval, iTimeOut) As Boolean
Parameters
Section titled “Parameters”sMsg (String)
Section titled “sMsg (String)”Name of the installation to show in the message, typically the product name.
sEstimatedTime (String)
Section titled “sEstimatedTime (String)”Estimated time (in minutes) for installation. The estimated time isn’t shown for uninstall, post and configure tasks.
iInterval (Integer)
Section titled “iInterval (Integer)”Used in logoff installation mode only. If you use 0, the user is logged off when the logoff message closes, whatever the user answers. Scripts created by the CapaInstaller Package Creator use 10.
iTimeOut (Integer)
Section titled “iTimeOut (Integer)”Not used by the current Scripting Library. Specify a value, for example 2, for compatibility.
Example
Section titled “Example”If bStatus Then bStatus = Job_InstallationStart("CapaInstaller", "5", 10, 2)Related functions
Section titled “Related functions”Job_AttendedInstallation Job_InstallationCompleted Job_PostInstallProcedure Job_SilentInstallation Constants Package Property Variables