Class Documentation

Name:Uninstall
Version:1.0
ID:ID_UNINSTALL
Status:Stable
Category:Tool
Date:January 2004
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2002-2004. All rights reserved.
Short:  Uninstalls software packages using XML-Uninstall files.



Actions

The Uninstall class supports the following actions:

Activate  Starts the package removal process.

Structure

The Uninstall object consists of the following public fields:

Location  The location of the uninstall file is specified here.
Output  Result messages will be sent to the object referred to in this field.
Static  Set to TRUE to make the object static.
Field:Location
Synonyms:Src
Short:The location of the uninstall file is specified here.
Type:STRING
Status:Get/Set

Before intiailising an install object you will need to set the location of the package that is to be installed. The package must have a '.install' extension and be compressed in a format supported by the Compression class (pkzip is currently recommended). If the file is not valid then the install object will fail when the Activate action is called.


Field:Output
Short:Result messages will be sent to the object referred to in this field.
Type:OBJECTID
Status:Read/Write

If this field is set to a valid ObjectID, text messages will be sent to the object when the print process executes. This can be helpful for notifying the user that an error has occurred during the print process.

The object receiving the message must be capable of understanding text sent via data channels. In most cases it is recommended that a Text object is used for this purpose.


Field:Static
Short:Set to TRUE to make the object static.
Type:LONG
Status:Read/Init

By default, an Uninstall object will execute itself and then self-destruct when a closing tag is received. If you would rather that the object stays in the system, set this field to TRUE. If you do this, the only way to get the Uninstall object to perform is to call the Activate action.