IPS_EnableDebug

 bool IPS_EnableDebug (int $InstanceID, int $Duration) 

Parameters

Returns

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

Description

The function activates the forwarding of debug messages for the instance with the ID InstanceID for Duration seconds. Debug messages which the instance sends during this time (e.g. via SendDebug) are distributed as message KL_DEBUG (10206). The management console uses the function for the display in the debug window of the instance.

Calling the function again restarts the duration from the current point in time. After the duration has expired, debug messages are no longer forwarded. The forwarding can be ended early with IPS_DisableDebug. Independently of this, debug messages can be written to a file with IPS_EnableDebugFile.

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, the forwarding of debug messages is automatically deactivated again.

Example

// Activate debug messages of instance 12345 for 5 minutes
IPS_EnableDebug(12345, 300);