TrFile_CopyFile (function reference)

By May 1, 2017 May 22nd, 2019 Online Help, Troi File Plug-in
Troi File Plug-in for FileMaker Pro

TrFile_CopyFile

Copies a file to the specified path.

SyntaxFunction badge

TrFile_CopyFile ( switches ; sourceFilepath ; destinationFilePath )

Parameters

switchesreserved for future use, leave empty or set to "-Unused"
sourceFilePaththe path to the file to copy
destinationFilePaththe 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:

0no errorThe file was copied
$$-43fnfErrSource file not found, or destination directory does not exist
$$-48dupFNErrDestination file already exists
$$-4254returnInPathErrThe path contains an illegal return character
$$-1genericErrThe file could not be copied

Other errors may be returned.

Originated in

Troi File Plug-in 1.1

Compatibility

FileMaker Pro 14 to 18

Considerations

You can use FileMaker styled paths, like “filemac:/MacHD/folderA/test.txt”.
Use the TrFile_DeleteFile to delete a file first if it exists. See also the function TrFile_SaveFileDialog to get a FileSpec for a file.

Example

Assume your C disk already contains a file “Testtext.txt”. We assume that a global number field gErrorCode is defined. Create the following script:

Set Field [ gErrorCode ; TrFile_CopyFile ( "-Unused" ; "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 Mac OS 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:

Set Field [ gErrorCode ; TrFile_CopyFile ( "-Unused" ; gSourceFilePath ;  gDestFilePath ) ]

This will copy the source file to the path indicated in the gDestFilePath.

Related functionsFunction badge

TrFile_CopyFolder
TrFile_CreateFile
TrFile_DeleteFile
TrFile_MoveFile
TrFile_SaveFileDialog
TrFile_SelectFileDialog

Related script stepScript step badge

Copy File

Related topics

Troi File Plug-in online help (overview)


Online Help Page for Troi File Plug-in for 14 to 18 –> TrFile_CopyFile (filep4210) 2019-0522 16:32:36