OverviewExamples
|
table SetupData.GetFileList ( |
Returns a numerically indexed table containing information about each file in the setup.
Note: Some returned values are not calculated until the files have actually been installed.
(number) The file list to retrieve. Choose from:
|
CONSTANT |
VALUE |
DESCRIPTION |
|
ARCHIVE_LIST |
0 |
Retrieve files in the setup archive. |
|
EXTERNAL_LIST |
1 |
Retrieve external files. |
|
BOTH_LISTS |
2 |
Retrieve both archive and external files. |
(table) A numerically indexed table containing the file properties for every file within the setup. Every index in this table contains a table of file properties, indexed by the following keys:
|
KEY |
TYPE |
DESCRIPTION |
|
AccessDate |
string |
The files last accessed date in the form: Tuesday, July 06, 2004, 12:46:06 PM |
|
AccessDateISO |
string |
The file's last accessed date in the ISO format. |
|
CompressFile |
boolean |
Whether the file is compressed within the archive. |
|
CRC |
number |
The file's CRC value. |
|
CreateBackup |
boolean |
Whether a backup of any existing file will be created before it is overwritten. |
|
CreationDate |
string |
The files creation date in the form: Tuesday, July 06, 2004, 12:46:06 PM |
|
CreationDateISO |
string |
The file's creation date in the ISO format. |
|
CustomShortcutPath |
string |
The full path to the location where the custom shortcut will be created. |
|
Destination |
string |
Where the file will be installed to. |
|
FailSafeCopy |
boolean |
Whether a fail-safe copy will be performed. |
|
FileDescription |
string |
The file's design-time description. This is the value entered in the Description field of a file's properties in the Setup Factory design environment. |
|
FileName |
string |
The file's filename. |
|
FileSource |
string |
The full path to the original location of the file. |
|
FileVersion |
string |
The file's version. |
|
FolderMatchMode |
number |
The folder match mode, if the current item is a folder reference: |
|
FolderRecurse |
boolean |
Whether the folder reference will be handled recursively. If the current item is a file, false will be returned. |
|
FontName |
string |
The font name to use when registering the file as a font. |
|
FullPath |
string |
The full path to the file, including file name. |
|
IconIndex |
number |
The index of the icon to use for the shortcut. |
|
IconPath |
string |
The external icon path to use for the shortcut. |
|
IconShowMode |
number |
The Icon show mode: |
|
InstallOrder |
number |
The install order of the file. |
|
IsArchive |
boolean |
Whether the original file was an archive file. |
|
IsFolderReference |
boolean |
Whether the current item is a folder reference. |
|
IsHidden |
boolean |
Whether the original file was hidden. |
|
IsInstalling |
boolean |
Whether the current item has been installed. This value is calculated at the time of the file's installation. |
|
IsInstallingOnReboot |
boolean |
Whether the current item will be installed on system reboot. This value is calculated at the time of the file's installation. |
|
IsReadOnly |
boolean |
Whether the original file was read only. |
|
IsRuntimeSourceOk |
boolean |
Whether the runtime source of the file is valid. |
|
IsSystem |
boolean |
Whether the original file was a system file. |
|
ModifiedDate |
string |
The files last modified date in the form: Tuesday, July 06, 2004, 12:46:06 PM |
|
ModifiedDateISO |
string |
The file's last modified date in the ISO format. |
|
NeverRemove |
boolean |
Whether this file will be left behind by the uninstall. |
|
NewAttributeArchive |
boolean |
Whether the Archive attribute will be applied to the file once it is installed. |
|
NewAttributeHidden |
boolean |
Whether the Hidden attribute will be applied to the file once it is installed. |
|
NewAttributeReadOnly |
boolean |
Whether the Read Only attribute will be applied to the file once it is installed. |
|
NewAttributeSystem |
boolean |
Whether the System attribute will be applied to the file once it is installed. |
|
Notes |
string |
The notes associated with the file. |
|
Overwrite |
number |
What will happen if the file already exists on the user's system: FILE_INSTALL_OLDER = 1 FILE_INSTALL_ALWAYS = 2 FILE_INSTALL_NEVER = 3 FILE_INSTALL_ASK = 4" |
|
Packages |
table |
A numerically indexed table of all of the packages that the current item belongs to. If it does not belong to any package, nil is returned. |
|
ProductVersion |
string |
The file's product version. |
|
RegisterAsOCX |
boolean |
Whether the file will be registered as an OCX. |
|
RegisterAsTLB |
boolean |
Whether the file will be registered as a Type Library. |
|
RegisterAsTTF |
boolean |
Whether the file will be registered as a True Type Font. |
|
SharedSystemFile |
boolean |
Whether the current item is a shared system file. |
|
ShorcutInStartMenuAppFolder |
boolean |
Whether a shortcut be created in Start Menu > %AppFolder% |
|
ShortcutArguments |
string |
The command line arguments that will be passed to the file when the user launches the shortcut. |
|
ShortcutDescription |
string |
The description that will accompany the shortcut. |
|
ShortcutInCustom |
boolean |
Whether a shortcut be created in the custom shortcut path |
|
ShortcutInDesktop |
boolean |
Whether a shortcut be created on the desktop |
|
ShortcutInQuickLaunch |
boolean |
Whether a shortcut be created in the quick launch folder |
|
ShortcutInStartMenu |
boolean |
Whether a shortcut be created in the start menu |
|
ShortcutInStartMenuPrograms |
boolean |
Whether a shortcut be created in Start Menu > Programs |
|
ShortcutInStartup |
boolean |
Whether a shortcut be created in the Startup folder |
|
SupressCRCCheck |
boolean |
Whether the CRC check is suppressed. |
|
SupressInUseNotice |
boolean |
Whether the "In Use" message will be suppressed when the file is installed. |
|
UseExternalIcon |
boolean |
Whether an external icon is used for the shortcut. |
|
UseOriginalAttributes |
boolean |
Whether the original attributes will be used, or if the new attributes are going to be used. |
If this action fails, nil will be 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