The final portion of the setup file contains sections that identify the programs that are to be run on the client workstation before or after an install, upgrade or an uninstall.
Below are examples of the syntax used in these exit programs sections to identify and run programs on the client workstation before or after an install, an upgrade, or an uninstall.
Example 1 - Optional program to be called before files are installed. This is only run during an initial install.
[PreInstallProgram] Program=whatever.exe CmdLine= CheckReturnCode= Wait=
| Field in [PreInstallProgram] | Description |
|---|---|
| Program | Required. Only the file name is used if a path is specified. The program must reside in the plug-in's <vendor>.<component> path in the installation source. |
| CmdLine | Optional. Whatever commands are required by the specific program. |
| CheckReturnCode | Optional. Default is N. Installation of this plug-in will not continue if this is set to Y and the return is non-zero. A message will not be displayed if the program returns a non-zero return code, but a message will be logged in the INSTLOG.TXT |
| Wait | Optional. Wait for program to terminate before continuing to execute. The default is Y. If CheckReturnCode=Y, then Wait=Y is used no matter what is specified here. |
Example 2 - Optional program to be called after files are installed. This is only run during an initial install.
[PostInstallProgram] Program=whatever.exe CmdLine= CheckReturnCode= Wait=
| Field in [PostInstallProgram] | Description |
|---|---|
| Program | Required. Only the file name is used if a path is specified. The program must reside in the plug-in's <vendor>.<component> directory on the PC. |
| CmdLine | Optional. Whatever commands are required by the specific program. |
| CheckReturnCode | Optional. The same values are supported for the PostInstallProgram as are supported in the PreInstallProgram, however, since the plug-in is already installed at this point, the CheckReturnCode value is not as significant. |
| Wait | Optional. Wait for program to terminate before continuing to execute. Again, the same values are supported for the PostInstallProgramas are for the PreInstallProgram, however, since the plug-in is already installed at this point, the CheckReturnCode value is not as significant. |
Example 3 - Optional program to be called before files are uninstalled.
[UninstallProgram] Program=whatever.exe CmdLine= CheckReturnCode= Wait=
| Field in [UninstallProgram] | Description |
|---|---|
| Program | Required. Only the file name is used if a path is specified. The program must reside in the plug-in's <vendor>.<component> directory on the PC. |
| CmdLine | Optional. Whatever commands are required by the specific program. |
| CheckReturnCode | Optional. Default is N. If the CheckReturnCode value is set to Y, the uninstall of the plug-in will not continue if the return value is non-zero. A message will not be displayed if the program returns a non-zero return code, but a message will be logged in the INSTLOG.TXT |
| Wait | Optional. Wait for program to terminate before continuing to execute. The default is Y. If CheckReturnCode=Y, then Wait=Y is used no matter what is specified here. |
Example 4 - Optional program to be called before files are upgraded.
[PreUpgradeProgram] Program=whatever.exe CmdLine= CheckReturnCode= Wait=
| Field in [PreUpgradeProgram] | Description |
|---|---|
| Program | Required. Only the file name is used if a path is specified. The program must reside in the plug-in's <vendor>.<component> path in the installation source. |
| CmdLine | Optional. Whatever commands are required by the specific program. |
| CheckReturnCode | Optional. Default is N. Installation of this plug-in will not continue if this is set to Y and the return is non-zero. A message will not be displayed if the program returns a non-zero return code, but a message will be logged in the INSTLOG.TXT |
| Wait | Optional. Wait for program to terminate before continuing to execute. The default is Y. If CheckReturnCode=Y, then Wait=Y is used no matter what is specified here. |
Example 5 - Optional program to be called after files have been upgraded.
[PostUpgradeProgram] Program=whatever.exe CmdLine= CheckReturnCode= Wait=
| Field in [PostUpgradeProgram] | Description |
|---|---|
| Program | Required. Only the file name is used if a path is specified. The program must reside in the plug-in's <vendor>.<component> path in the installation source. |
| CmdLine | Optional. Whatever commands are required by the specific program. |
| CheckReturnCode | Optional. The same values are supported for the PostUpgradeProgram as are supported in the PreUpgradeProgram, however, since the plug-in is already installed at this point, the CheckReturnCode value is not as significant. |
| Wait | Optional. Wait for program to terminate before continuing to execute. The default is Y. If CheckReturnCode=Y, then Wait=Y is used no matter what is specified here. |
