openLogViewer()
Opens the Log Viewer.
Synopsis
int openLogViewer( bool docked = false);
Parameters
Parameter | Meaning |
---|---|
docked | Determines the docked state of the Log Viewer. |
Return value
The function returns 0 when it was successfully executed and in case of errors -1.
Error
-
Description
This function opens the Log Viewer.
The Log Viewer will either be docked to the module it was opened for or displayed as a separate window. The separate window can be docked manually, the docking state will not be changed in code, so the Log Viewer will open as separate window again after it is closed.
The example opens the log viewer:
main(mapping event)
{
int i = openLogViewer();
DebugN("Log viewer opened:", i);
}
Assignment
Dialog functions
Availability
UI