Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:08Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextLog}}
Reads a UTF-16 log file and adds each line to a text log as a new entry.

<pre>
TextLogLoadFromFile(logName, fileName)
</pre>

== Arguments ==
;logName : <code>string</code> – Name of the text log to add the lines to.
;fileName : <code>wstring</code> – Path of the file. It must be inside the client's log directory.

== Returns ==
Nothing.

== Details ==
* The file must start with a UTF-16 byte-order mark. Otherwise the ''is not a valid unicode log file'' error is raised.
* The file is split at line feeds. Each line is added as if by [[API:TextLogAddEntry|TextLogAddEntry]] with filter type <code>0</code>, so the usual rules apply: the entry limit, the enabled flag, the update event and incremental saving.
* The whole line becomes the entry text. A file written by incremental saving therefore gives entries that start with the saved date, time and filter name, and that end with the carriage return written before each line feed.
* If incremental saving to the same log is on, the loaded lines are written to the log's file again.
* If the file does not exist, nothing is loaded.
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.
* The stock UI never calls this function.

== Errors ==
* <code>Error in function call 'TextLogLoadFromFile': Text Log %s does not exist</code>
* <code>Error in function call 'TextLogLoadFromFile': File '%s' is not in the log directory '%s'.</code>
* <code>Error in function call 'TextLogLoadFromFile': File '%s' is not a valid unicode log file.</code><br/>This message is formatted as a narrow string while the file name is a wide string, so usually only the first character of the name appears.

== Example ==
A minimal example built from the documented signature:
<pre>
TextLogCreate( "OldLog", 1000 )
TextLogLoadFromFile( "OldLog", L"logs/uilog.log" )
</pre>

== See also ==
* [[API:TextLogSetIncrementalSaving|TextLogSetIncrementalSaving]]
* [[API:TextLogAddEntry|TextLogAddEntry]]

API:TextLogLoadFromFile - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)