IPS_EnableDebugFile

Require: Symcon >= 5.2

 bool IPS_EnableDebugFile (int $InstanceID) 

Parameters

Returns

If the function succeeds, it returns TRUE, otherwise FALSE.

Description

The function activates the writing of debug logs to a file for the instance with the ID InstanceID.
The debug file is located in the logs folder (e.g. /var/log/symcon/debug_<InstanceID>.log).

If InstanceID is an object mirrored via Sync Remote, the function reports the error "Remote instances cannot be debugged". Debug messages of mirrored instances can only be displayed directly on the remote system.

This option is temporary. After restarting the IP-Symcon service, debug logging is automatically deactivated again.

Example

// Activates the writing of debug logs for instance 12345
IPS_EnableDebugFile(12345);

// Filename: debug_12345.log