OverviewExamples
table UninstallData.GetItem ( |
Gets an item's details from the uninstall's configuration file.
(number) The type of item you want to get. The type of item determines what the Identifier is. 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's details. |
UNINDATA_SESSIONVARS |
2 |
A session variable. |
UNINDATA_SUPPORTFILES |
3 |
A support file's details such as a primer file, image, plugin etc. |
UNINDATA_SHORTCUTS |
4 |
A shortcut (.lnk) file's details. |
UNINDATA_FOLDERS |
5 |
A folder's details. |
UNINDATA_SCRIPTS |
6 |
An extra script to run during the uninstall. |
(string) The Identifier of the type you want to get. Below you will find the key identifiers to use:
CONSTANT |
IDENTIFIER |
DESCRIPTION |
UNINDATA_MAIN |
Name |
The main item name 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). |
UNINDATA_FILES |
Filename |
The full path and filename of the file. |
UNINDATA_SESSIONVARS |
Name |
The session variable name. |
UNINDATA_SUPPORTFILES |
Filename |
The full path to the support file such as a primer file, image, plugin etc. |
UNINDATA_SHORTCUTS |
Filename |
The full path to the shortcut (.lnk) file. |
UNINDATA_FOLDERS |
FolderPath |
The full path to the folder. |
UNINDATA_SCRIPTS |
ID |
The unique ID for the script. |
(table) A table containing the specified item's details. The table's contents are based upon the ItemType specified. One of the following tables is returned:
KEY |
TYPE |
DESCRIPTION |
Name |
string |
The main item identifier such as "DataFilePath", "CPRegKey", "EXELocation", "AppShortcutFolderPath" or "UninstallReverseOrder." |
Value |
string |
The value of the 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. You can access this item using ItemData.Value. "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). |
KEY |
TYPE |
DESCRIPTION |
Filename |
string |
The full path and filename of the file added to the uninstall. You can access this value using ItemData.Filename. |
DecrementUsageCount |
boolean |
Whether the added file is set to have its usage count decremented when uninstalled. The returned value true means it will decrement the count. You can access this value using ItemData.DecrementUsageCount. |
UnregisterCOM |
boolean |
Whether the added file is set to be unregistered when uninstalled. The value true means it will unregister the file. You can access this value using ItemData.UnregisterCOM. |
UnregisterFont |
boolean |
Whether the file will be unregistered if it is a Font file. The value true to means it will unregister the font file. You can access this value using ItemData.UnregisterFont. |
FontDesc |
string |
The font description if the file is a TTF file. You can access the description using ItemData.FontDesc. |
BackupFile |
string |
The full path and filename of the backed up file if a backup was performed
on the file during the install. If no backup was performed, an empty string
is stored. You can access this value using ItemData.BackupFile. |
KEY |
TYPE |
DESCRIPTION |
Name |
string |
The session variable name added to the uninstall. You can access this value using ItemData.Name. |
Value |
string |
The contents of the session variable added to the uninstall. You can access this value using ItemData.Value. |
KEY |
TYPE |
DESCRIPTION |
Filename |
string |
The full path and filename of the support file added to the uninstall. You can access this value using ItemData.Filename. |
KEY |
TYPE |
DESCRIPTION |
Filename |
string |
The full path and filename of the shortcut file (*.lnk) added to the uninstall. You can access this value using ItemData.Filename. |
KEY |
TYPE |
DESCRIPTION |
FolderPath |
string |
The full path and folder name of the folder added to the uninstall. You can access this value using ItemData.FolderPath. |
KEY |
TYPE |
DESCRIPTION |
ID |
string |
The unique ID for the script. You can access this value using ItemData.ID. |
Timing |
number |
The timing of the script (when it will be run during uninstall). This will be one of the following value: 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. You can access this value using ItemData.Timing. |
Script |
string |
The script set to be run to run. You can access this value using ItemData.Script. |
If an error occurs, nil is returned. You can use Application.GetLastError to determine whether this action failed, and why.
When adding an action with the action editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions