Get 4D file

Home

4D v16.3

Get 4D file


Get 4D file ( file {; *} ) -> Function result

Parameter	Type	Description
file	Longint	File type
*	Operator	Return file path of host database
Function result	String	Pathname to 4D file

Description

The Get 4D file command returns the pathname to the 4D environment file specified by the file parameter. The path is returned using the system syntax.

This command allows you to get the actual pathname of specific files, whose name or location can depend on database context. It also helps you to write generic code which is independent from the 4D version or the OS.

In file, pass a value to specify the file for which you want to get the full pathname. You can use one of the following constants, located in the "4D Environment" theme:

Constant	Type	Value	Comment
Backup configuration file	Longint	1	Backup.xml file, stored in Preferences/Backup folder next to database structure file.
Last backup file	Longint	2	Last backup file, named <databaseName>[bkpNum].4BK, stored at a custom location.
User settings file	Longint	3	settings.4DSettings file for all data files, stored in Preferences folder next to database structure file if enabled.
User settings file for data	Longint	4	settings.4DSettings file for current data file, stored in Preferences folder next to the data file.

When the command is called from a component, pass the optional * parameter to get the file path of the host database. In this case, if you omit the * parameter, an empty string is always returned.

Regarding User settings file and User settings file for data, a path is returned only if the Enable User Settings in External File security option has been checked in the "Database Settings" dialog box (see Enabling User Settings mode).

Example

You want to get the path of the last backup file:

 C_TEXT($path)

 $path:=Get 4D file(Last backup file)

  // $path = "C:\Backups\Countries\Countries[0025].4BK" for example