# Function Reference

FileInstall

Include and install a file with the compiled script.

FileInstall ( "source", "dest" [, flag] )

Parameters

source | The source path of the file to compile. This must be a literal string; it cannot be a variable.
dest | The destination path with trailing backslash. This can be a variable.
flag | [optional] this flag determines whether to overwrite files if they already exist: 0 = (default) do not overwrite existing files 1 = overwrite existing files

Return Value

Success: | Returns 1.
Failure: | Returns 0.

Remarks

The FileInstall function is designed to include files into a compiled AutoIt script. These included files can then be "extracted" during execution of the compiled script if the statement is executed. Keep in mind that files such as images can greatly increase the size of a compiled script.
The source file must be a string and not a variable so that the compiler can extract the filename to include. The source cannot contain wildcards.
When this function is used from a non-compiled script, a copy operation is performed instead (to allow for easy testing pre-compilation).
Files maintain their original creation/modification timestamps when installed.

Related

#Include

Example

; Include a bitmap found in "C:\test.bmp" with the compiled program and put it in "D:\mydir\test.bmp" when it is run
$b = True
If $b = True Then FileInstall("C:\test.bmp", "D:\mydir\test.bmp")