[This is preliminary documentation and subject to change.]

Switches the log user interface to be pinned on top of the screen or not.

[Visual Basic]
Function SetOnTop( _ 
   ByVal p_bValue As Boolean _ 
) As Boolean
[C#]
bool SetOnTop(
   bool p_bValue
);
[C++]
bool SetOnTop(
   bool p_bValue
);
[JScript]
function SetOnTop(
   bool p_bValue
): bool;

Parameters

p_bValue

True if the user interface should be on top, false otherwise.

Return Value

True if the log was already set on top, false if it was not.

Remarks

Use this method to pin or unpin the log user interface on top of the other windows.

This method may have no effect with some implementations of the log where being windows are not used (like with a console or a file output).

See Also

ILog Interface | Okapi.Library.Base Namespace

---