 |
Copy File |
Copies a file to the specified path.
Syntax
Copy File [ Select ; Result (error) ; Source filePath ;
Destination filePath ]
Options
| Select entire contents | replaces the contents of a field with the result. If not checked the result replaces the currently selected portion of the field |
| Result (error) | an error code |
| Source filePath | the path to the file to copy |
| Destination filePath | the path where the file must be copied to |
Returned Result
Data type returned
Error code
Result
The returned result is an error code. An error always starts with 2 dollars, followed by the error code. You should always check for errors. Returned error codes can be:
| 0 | no error | The file was copied |
| $$-43 | fnfErr | Source file not found, or destination directory does not exist |
| $$-48 | dupFNErr | Destination file already exists |
| $$-4254 | returnInPathErr | The path contains an illegal return character |
| $$-1 | genericErr | The file could not be copied |
Other errors may be returned.
Originated in
Troi File Plug-in 9.0
Compatibility
FileMaker Pro 16 to FileMaker Pro 2023
Considerations
You can use FileMaker styled paths, like “filemac:/MacHD/folderA/test.txt”.
Use the Delete File script step to delete a file first if it exists. See also the script step Show Save File Dialog to get a Filepath for a file.
Example
Assume your C disk already contains a file “Testtext.txt”. We assume that a global field gErrorCode is defined. Create the following script:
Copy File [ Select ; gErrorCode ; "C:\Testtext.txt" ; "D:\MyFiles\TestDupl.txt" ) ]This script will copy the file “Testtext.txt” to the “TestDupl.txt” file in directory “MyFiles” on the D: disk. On macOS the paths will be of the form “Mac HD:MyFiles:TestDupl.txt”.
Example 2
We assume that in your FileMaker file the following fields are defined:
gErrorCode Global, number
gSourceFilePath Global, text
gDestFilePath Global, text
gSourceFilePath should contain the path to an existing file, for example “D:\Logs\Log01.TXT” (Windows) or “Mac HD:Logs:Log 1” (Mac). gDestFilePath should contain the path to the destination and should not exist, for example “D:\Logs\L2000_01.TXT” (Windows) or “Mac HD:Logs:Log 2000_01” (Mac). In a script add the following script step:
Copy File [ Select ; gErrorCode ; gSourceFilePath ; gDestFilePath ]This will copy the source file to the path indicated in the gDestFilePath.
Related script steps
| Copy Folder |
| Create File |
| Delete file |
| Show Save File Dialog |
| Show Select File Dialog |
Related function
| TrFile_CopyFile |
Related topics
Troi File Plug-in online help (overview)
