OverviewExamples
Adds an item to the uninstall configuration file.
Note: This action can only be used during the install and will not work during the uninstall.
(number) The type of item you want to add. This setting determines what the ItemData table should contain. Choose from:
CONSTANT |
VALUE |
DESCRIPTION |
UNINDATA_MAIN |
0 |
A main item such as: "DataFilePath" - The full path to the uninstall data file (*.dat). "CPRegKey" - The uninstall Registry key. "EXELocation" - The full path to the uninstall executable. "AppShortcutFolderPath" - The path to the application's shortcut folder. "UninstallReverseOrder" - Whether or not the files will be uninstalled in reverse order. |
UNINDATA_FILES |
1 |
A file to be uninstalled. |
UNINDATA_SESSIONVARS |
2 |
A session variable. |
UNINDATA_SUPPORTFILES |
3 |
A support file such as a primer file, image, plugin etc. |
UNINDATA_SHORTCUTS |
4 |
A shortcut (.lnk) file. |
UNINDATA_FOLDERS |
5 |
A folder to be uninstalled. |
UNINDATA_SCRIPTS |
6 |
An extra script to run during the uninstall. |
(table) A table whose contents depend upon the ItemType selected. Each table contains the following indexes:
KEY |
TYPE |
DESCRIPTION |
Name |
string |
A main item such as: "DataFilePath" - The full path to the uninstall data file (*.dat). "CPRegKey" - The uninstall Registry key. "EXELocation" - The full path to the uninstall executable. "AppShortcutFolderPath" - The path to the application's shortcut folder. "UninstallReverseOrder" - Whether or not the files will be uninstalled in reverse order ("1" means they will be uninstalled in reverse order and "0" means that they will be uninstalled in the same order as they were installed). You can set this item by assigning the value to ItemData.Name. |
Value |
string |
The value to assign to the main item. You can set this value by assigning it to ItemData.Value. |
KEY |
TYPE |
DESCRIPTION |
Filename |
string |
The full path and filename of the file you want to add to the uninstall. You can assign this value to ItemData.Filename. |
DecrementUsageCount |
boolean |
Whether the added file should have its usage count decremented when uninstalled. Assigning true to ItemData.DecrementUsageCount will decrement the count. |
UnregisterCOM |
boolean |
Whether the added file should be unregistered when uninstalled. Assigning true to ItemData.UnregisterCOM will unregister the file. |
UnregisterFont |
boolean |
Whether to unregister the file if it is a Font file when uninstalled. Assigning true to ItemData.UnregisterFont will unregister the font file. |
FontDesc |
string |
The font description if the file is a TTF file. You can assign the description to ItemData.FontDesc. |
BackupFile |
string |
The full path and filename of the backed up file, if the file was backed
up during the install, or an empty string if no backup was performed.
If needed you can assign the path to ItemData.BackupFile. |
KEY |
TYPE |
DESCRIPTION |
Name |
string |
The session variable you want to add to the uninstall. For example, ItemData.Name = "%MyValue%". |
Value |
string |
The contents of the session variable you want to add to the uninstall. This value can be assigned to ItemData.Value. |
KEY |
TYPE |
DESCRIPTION |
Filename |
string |
The full path and filename of the support file you want to add to the uninstall. You can assign this file path to ItemData.Filename. |
KEY |
TYPE |
DESCRIPTION |
Filename |
string |
The full path and filename of the shortcut file (*.lnk) you want to add to the uninstall. You can assign the path to ItemData.Filename. |
KEY |
TYPE |
DESCRIPTION |
FolderPath |
string |
The full path and folder name of the folder you want to add to the uninstall. You can assign this path to ItemData.FolderPath. |
KEY |
TYPE |
DESCRIPTION |
ID |
string |
A unique ID for the script, mainly used to identify it later. |
Timing |
number |
The timing of the script (when it will be run during uninstall). Choose from 0=Before On Startup, 1=After On Startup, 2=Before On Pre Uninstall, 3=After On Pre Uninstall, 4=Before On Post Uninstall, 5=After On Post Uninstall, 6=Before On Shutdown, 7=After On Shutdown |
Script |
string |
The script to run. |
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions