openLogViewer()
Opens the Log Viewer.
Synopsis
int openLogViewer( bool docked = false);Parameters
| Parameter | Description |
|---|---|
| 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.
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.
When openLogViewer() is set to TRUE, the
LogViewer always opens docked, regardless of it's previous state.
When openLogViewer() is set to FALSE, the
LogViewer opens in the state it had when it was last closed, which can be either
docked or undocked.
The separate window can be docked manually, in which case the docking state will
not be changed in the code. Therefore, if openLogViewer() is
set to FALSE, 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