TrFile_CreateFile (function reference)

By May 1, 2017May 20th, 2020Online Help, Troi File Plug-in
Troi File Plug-in > Functions reference > TrFile_CreateFile
Troi File Plug-in for FileMaker Pro

TrFile_CreateFile

Creates a new empty file in the location indicated by the filePath. This function requires no user intervention.

SyntaxFunction badge

TrFile_CreateFile ( switches ; filePath )

Parameters

switchesmodifies the action of the function
filePaththe path to the file to create

Switches

Switches can be empty or:

-CreateFoldersalso create new folders if they don’t exist in the specified path

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 created
$$-48dupFNErrDestination file already exists
$$-1genericErrThe file could not be created

Other errors may be returned.

Originated in

Troi File Plug-in 1.0

Compatibility

FileMaker Pro 15 to 19

Considerations

You can use FileMaker styled paths, like “filewin:/C:/MyFiles/test.txt”.
See also the function TrFile_SaveFileDialog to get a filepath for the file.
Starting with Troi File Plug-in 12.0 you can omit filemac: or filewin: too! Any path starting with a slash will be parsed as a FileMaker style path (of the platform FileMaker is running).

Example

Set Field [ gErrorCode ; TrFile_CreateFile ( "-Unused" ; "C:\Testtext.txt" ) ]

This will create the empty file “Testtext.txt” on the C disk.

Set Variable [ $ErrorCode ; TrFile_CreateFile ( "-CreateFolders" ; "/macHD/users/ad/nw/foldB/myfile.log" ) ]

This will create the empty file “myfile.log”. This will also create new folders if they don’t exist in the specified path, for example the folders “nw” and “foldB” may be created.

Example 2

We assume that in your FileMaker file the following fields are defined:

  gErrorCode		Global, number
  gDestFilePath		Global, text 

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 scriptstep:

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

This will create the file indicated in the gDestFilePath.

Related functionsFunction badge

TrFile_DeleteFile
TrFile_ExportToFile
TrFile_SetContents
TrFile_SetDefaultCreator
TrFile_SetDefaultType

Related script stepScript step badge

Create File

Related topics

Troi File Plug-in online help (overview)


Online Help Page for Troi File Plug-in for 15 to 19 –> TrFile_CreateFile (filep4211) 2020-0520 15:54:04