InstallAware for Windows Installer
 

System Restore

This command is used to create Windows System Restore Points as part of your installation.

Use this command before your setup has made any changes to the target system with the Begin System Restore Point option. After your setup has completed making all necessary changes to the target system (or has failed/been cancelled), use this command again with the End System Restore Point option.

Multiple calls to this command may be nested within the same setup, or across multiple setups.

Begin System Restore Point

Select this radio button to begin creating a new system restore point. Each invocation of the command with this option must be matched with another invocation using the End System Restore Point option.

The following fields apply only when this radio button has been selected:

Restore Point Name

Type in a descriptive name for the system restore point. This localizable field will be visible to end-users when they are running Windows System Restore.

Action

Select the action that best describes the operation being undertaken by your installation.

Variable for System Restore Point Index

This variable will receive the unique numeric index of the Windows System Restore Point that will be created. The value received in this variable must be preserved and passed to this command when invoked using the End System Restore Point option.

If the command fails, the following values are returned:

Value Meaning
SAFEMODE Windows System Restore Points cannot be created in Windows Safe Mode.
DISKFULL Insufficient disk space for processing.
FILERENAME A pending file rename operation has aborted processing (applies only to Windows ME).
INTERNAL An internal error occurred in Windows System Restore.
SEQUENCE The command has been called with invalid data.
DISABLED The Windows System Restore service has been disabled.
TIMEOUT A timeout occurred in Windows System Restore.
UNINSTALLED Windows System Restore has not been installed (it is not installed by default on the Windows Server family of products).
UNKNOWN An unknown error occurred. Check to make sure setup is running with fully elevated privileges.

End System Restore Point

Select this radio button to finish creating a previously started system restore point. Each invocation of the command with this option must follow a previously made invocation with the Begin System Restore Point option.

The following fields apply only when this radio button has been selected:

System Restore Point Index

Provide the unique Windows System Restore Point index in this field, obtained using the previous invocation of the command. If a non-numeric value is provided, the call to the command is ignored.

Discard System Restore Point

If setup has failed, been cancelled, or the Windows System Restore Point is to be discarded for any other reason, check this box. Otherwise, leave it unchecked to finalize Windows System Restore Point creation.

 Notes

  • Windows System Restore is not consistent across different versions of Windows regarding the file types that are protected. Some versions of Windows even permit end-users to customize the types of files and locations of folders that are monitored (NT 5.x), while others do not allow it (NT 6.x).
  • Windows System Restore may occasionally relocate files to incorrect folders, creating duplicate folders of the form original folder, original folder (2), and so forth - when only one folder was originally present.
  • These limitations also affect your cached setup sources and other saved setup data when Windows System Restore partially restores an InstallAware setup that has since been removed. In this scenario, end-users will receive an error message that mia.lib is missing, because it has not been restored. Some other critical setup data and cached setup sources may also be missing.
  • InstallAware requires end-users to run your original setup file (as originally downloaded or found on optical media), instead of any locally cached copy - including the one accessed using the Control Panel Programs and Features applet - any time an InstallAware setup has been inconsistenly restored to a system.
  • Because of the above considerations, InstallAware recommends you create a Windows System Restore Point only when installing your application (and not when removing it).
  • Uninstalling a partially restored InstallAware setup from its original sources will resolve any inconsistencies produced by Windows System Restore.
  • The same considerations apply to your own applications that may be incompletely restored by Windows System Restore, depending on the type of files produced and consumed by your applications at runtime, the version of Windows you are running, and any end-user customizations.