OverviewExamples
|
boolean File.Install ( |
Installs a file onto the user's system.
Note: This is just like copying the file, but with a few more options.
(string) The path to the file that you want to install.
(string) The full path and filename of the destination that you want to install to.
(number) Whether to overwrite a file in the destination folder if it has the same name as the file being installed:
|
CONSTANT |
VALUE |
DESCRIPTION |
|
FILE_INSTALL_SAMEOLDER |
0 |
Only overwrite the existing file if it's older than the file being installed, or if both files are the same age. (Default) |
|
FILE_INSTALL_OLDER |
1 |
Only overwrite the existing file if it's older than the file being installed. |
|
FILE_INSTALL_ALWAYS |
2 |
Always install the file, even if the existing file is newer. |
|
FILE_INSTALL_NEVER |
3 |
Never install the file, even if the existing file is older. |
|
FILE_INSTALL_ASK |
4 |
Ask the user if the existing file should be overwritten. |
|
FILE_INSTALL_CALLBACK |
6 |
Call the OverwriteCallbackFunction to handle the overwriting of the file in a custom way. |
Warning: It is generally not a good idea to choose FILE_INSTALL_ALWAYS unless you are certain that this is what you want to do. Also, do not choose FILE_INSTALL_ASK unless you are confident that the user will have the knowledge to make such a decision. FILE_INSTALL_SAMEOLDER is generally the safest choice.
(boolean) Whether to create a backup of the existing file (if there is one) during the installation:
|
VALUE |
DESCRIPTION |
|
true |
Any existing file will be renamed to filename.bak. If filename.bak already exists, the file will be renamed to filename.bk1 instead, or filename.bk2, or filename.bk3, etc. The new file will only be installed after the existing one has been backed up. |
|
false |
Don't backup the existing file. (Default) |
(boolean) Whether the file is a system file that may be shared by multiple programs:
|
VALUE |
DESCRIPTION |
|
true |
Keep a usage count for the file during installation and uninstallation to make sure it isn't removed when it's still needed. |
|
false |
The file isn't going to be shared, so don't keep a usage count. (Default) |
(function) The name of a function that will be called whenever progress is made in the install operation. (You can use this callback function to display the progress of the install operation in your own custom way.)
Note: If ProgressCallbackFunction is set to nil, then the progress information will be sent to the built-in status dialog, assuming it is currently visible. (You can show or hide the status dialog with a StatusDlg.Show or StatusDlg.Hide action.)
The callback function must be able to receive the following parameters:
(string) The source path of the file being installed.
(string) The destination path for file being installed.
(number) The number of bytes installed so far.
(number) The total bytes that will be installed.
The callback function should return a boolean value (true or false) indicating whether the install operation should continue:
|
VALUE |
DESCRIPTION |
|
true |
Continue with the install operation. |
|
false |
Stop the install operation as soon as possible. |
(function) The name of a function that will be called whenever an overwrite decision must be made. (You can use this callback function to handle the overwrite operation in your own custom way.)
Note: If OverwriteCallbackFunction is set to nil, then the FILE_INSTALL_SAMEOLDER overwrite option will be used.
The callback function must be able to receive the following parameters:
(string) The source path of the file to install.
(string) The destination path for file being installed.
The callback function should return a boolean value (true or false) indicating whether or not to overwrite the file:
|
VALUE |
DESCRIPTION |
|
true |
Overwrite the file. |
|
false |
Do not overwrite the file. |
(boolean) True if the file was installed, or false if it wasn't or if an error occurs. You can use Application.GetLastError to determine whether this action failed, and why.
Note: If the destination file already exists and is protected by Windows File Protection (WFP), false will be returned.
See also: Related Actions