Get 4D file

Home

4D v20 R7

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 history file	Longint	19	Backup history file (see Configuration and trace files). Stored in the backup destination folder.
Backup log file	Longint	13	Current backup journal file (see Configuration and trace files). Stored in the Logs folder of the database.
Backup settings file	Longint	18	Default backup.4DSettings file (xml format), stored in the Settings folder of the database
Backup settings file for data	Longint	17	backup.4DSettings file (xml format) for the data file, stored in the Settings folder of the data folder
Build application log file	Longint	14	Current log file in xml format of the default application builder configuration file (buildApp.4DSettings). Stored in the Logs folder of the database.
Build application settings file	Longint	20	Default settings file of the application builder ("buildApp.4DSettings"). Stored in the Settings folder of the database.
Compacting log file	Longint	6	Log file of the most recent compacting done with the Compact data file command or the Maintenance and security center. Stored in the Logs folder of the database.
Current backup settings file	Longint	1	backup.4DSettings file currently used by the application. It can be the backup settings file (default) or a custom user backup settings file defined for the data file
Debug log file	Longint	12	Log file created by the SET DATABASE PARAMETER(Debug log recording) command. Stored in the Logs folder of the database.
Diagnostic log file	Longint	11	Log file created by the SET DATABASE PARAMETER(Diagnostic log recording) command. Stored in the Logs folder of the database.
Directory file	Longint	16	directory.json file, containing the description of users and groups (if any) for the project database. It can be located either in the user database settings folder (default, global to the project), or in the data settings folder (specific to a data file).
HTTP Client log file	Longint	24	Log file created by the HTTP SET OPTION(HTTP client log;value) command. Stored in the Logs folder.
HTTP debug log file	Longint	9	Log file created by the WEB SET OPTION(Web debug log) command. Stored in the Logs folder of the database.
HTTP log file	Longint	8	Log file created by the WEB SET OPTION(Web log recording) command. Stored in Logs folder of the database.
IMAP Log file	Longint	23	Log file created by the SET DATABASE PARAMETER(IMAP Log) command. Stored in the Logs folder of the database
Last backup file	Longint	2	Last backup file, named <databaseName>[bkpNum].4BK, stored at a custom location.
Last journal integration log file	Longint	22	Full pathname of the last journal integration log file (stored in the Logs folder of the restored application), if any. This file is created, in auto-repair mode, as soon as a log file integration occurred (see ).
POP3 Log file	Longint	21	Log file created by the SET DATABASE PARAMETER(POP3 Log) command. Stored in the Logs folder of the database.
Repair log file	Longint	7	Log file of database repairs made on the database in the Maintenance and Security Center (MSC). Stored in the Logs folder of the database.
Request log file	Longint	10	Standard client/server request log file (excluding Web requests) created by the SET DATABASE PARAMETER(4D Server log recording) or SET DATABASE PARAMETER(Client log recording) commands. If executed on the server, the server log file is returned (stored in the Logs folder on the server). If executed on the client, the client log file is returned (stored in the client local Logs folder).
SMTP log file	Longint	15	Log file created by the SET DATABASE PARAMETER(SMTP Log) command. Stored in the Logs folder of the database.
User settings file	Longint	3	settings.4DSettings file for all data files, stored in Settings folder next to database structure file if enabled.
User settings file for data	Longint	4	settings.4DSettings file for current data file, stored in Settings folder next to the data file.
Verification log file	Longint	5	Log files created by the VERIFY CURRENT DATA FILE and VERIFY DATA FILE commands or the Maintenance and Security Center (MSC). Stored in the Logs folder of the database.

If the target file does not exist, an empty path is returned. No errors are raised.

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 for data and User settings file, 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 ).

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