cancelInstall

Summary

Aborts installation of the software; performs cleanup of temporary files.

Method of

Install object

Syntax

void cancelInstall()
void cancelInstall( int errorCode )

Parameters

None.

Returns

An integer error code. The optional argument is an error code that can be returned to the triggering page. For most purposes, it's recommended that one of the standard return codes be used. But a script can, in fact, return any valid integer. For a list of possible values, and any custom errorCode created by install writer, see Return Codes.

Example

Use the following code to abort or to finalize an installation, based on a variable you set earlier in your code:

initInstall("Royal Airways TripPlanner","/RoyalAirways/
TripPlanner","1.0.0.0");
...
err = getLastError();
if (!err)
   performInstall();
else
   cancelInstall(err);

Document Tags and Contributors

 Last updated by: Sheppy,