dbgEnableLog (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Operating mode of the runtime log
Various

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

dbgEnableLog (Function)

In french: dbgActiveLog

Enables the runtime log through programming.

Remark: The runtime log is a ".wlog" file containing all the codes corresponding to the actions performed by the user. If the project corresponding to the runtime log is opened in the editor, the log file can be directly opened in the editor:

on the "Home" tab, in the "General" group, expand "Open", select "Open" and select the desired ".wlog" file.
by performing a Drag and Drop of the ".wlog" file from the file explorer to the editor.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 19 and later

This function is now available for iPhone/iPad applications.

New in version 19

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

This function is now available in Universal Windows 10 App mode.

Example

// Active le log d'exécution par défaut
dbgEnableLog()

Syntax

<Result> = dbgEnableLog([<Log file> [, <Options>]])

<Result>: Boolean

True if the runtime log was started,
False otherwise.

<Log file>: Optional character string

Location and name of the log file to create. The name and location of the log file can be:
fully customized.
constructed using the following keywords:
[%ExeDir%] Directory of executable, always filled with the "\" character. This directory is equivalent to the result of fExeDir.
[%ExeName%] Name of the executable.
[%Date%] Start date of runtime log (YYYYMMDD format).
[%Time%] Start time of runtime log (HHMMSS format).
[%UserName%] Name of the current user.
[%ComputerName%] Name of the machine.
Versions 18 and later
[%DataDir%]
New in version 18
[%DataDir%]
[%DataDir%] Directory of the HFSQL data files specified by the user when installing the application. This directory is equivalent to the result of fDataDir.
Versions 18 and later
[%DirUserData%]
New in version 18
[%DirUserData%]
[%DirUserData%] Directory for the data of the current user of the current application. This directory is equivalent to the result of fDataDirUser.

By default, the name of the Log file corresponds to: "[%UserDataDir%][%ExeName%]_[%Date%]_[%Time%]".
For example: "C:\Users\Doc\AppData\Roaming\Applications WINDEV\MonAppli\Monappli_20071023_130812.wlog".
Versions 22 and later
Caution: If you use the dynamic string construction ("Allow "[% %]" in the strings" in the "Compilation" tab of the project description), a compilation error occurs (unknown identifier). In this case, each string must be preceded by '-%'. Example:

dbgEnableLog("[%RepDonneesUtilisateur%][%NomExe%]_[%Date%]_[%Heure%]")

becomes

dbgEnableLog(-%"[%RepDonneesUtilisateur%][%NomExe%]_[%Date%]_[%Heure%]")

New in version 22
Caution: If you use the dynamic string construction ("Allow "[% %]" in the strings" in the "Compilation" tab of the project description), a compilation error occurs (unknown identifier). In this case, each string must be preceded by '-%'. Example:

dbgEnableLog("[%RepDonneesUtilisateur%][%NomExe%]_[%Date%]_[%Heure%]")

becomes

dbgEnableLog(-%"[%RepDonneesUtilisateur%][%NomExe%]_[%Date%]_[%Heure%]")

Caution: If you use the dynamic string construction ("Allow "[% %]" in the strings" in the "Compilation" tab of the project description), a compilation error occurs (unknown identifier). In this case, each string must be preceded by '-%'. Example:

dbgEnableLog("[%RepDonneesUtilisateur%][%NomExe%]_[%Date%]_[%Heure%]")

becomes

dbgEnableLog(-%"[%RepDonneesUtilisateur%][%NomExe%]_[%Date%]_[%Heure%]")

<Options>: Optional Integer constant (or combination of constants)

Used to configure the options of the runtime log:
LogEnabled The runtime log is immediately enabled.
LogWLanguageFunctions The WLanguage functions are written into the runtime log.
LogParameters The parameters of the functions are written into the runtime log.
LogPause The runtime log is not immediately enabled
LogAll The runtime log retrieves:
the WLanguage functions
the parameters of the functions
the processes
LogProcessOnly The runtime log only retrieves information about the processes.

The combination LogEnabled + LogWLanguageFunctions is used by default if this parameter is not specified.

Remarks

Operating mode of the runtime log

The dbgEnableLog function must be called only once. Any other call to this function will have no effect.
To temporarily enable or disable the runtime log, use dbgLogStatus.
To modify the options of the runtime log, use dbgLogOption.

Remark: The runtime log can also be started via the ".wx" file found beside the executable. For more details, see Runtime log.

Various

The dbgEnableLog function can be used in a REST webservice.
The location of the log file can be fully customized. In this case, do not forget the problems of rights that may arise.
Reminder: The data directory is normally always available in set.

Component: wd270vm.dll