Get Composition Log

Command line:
tlapi ‑cGETLOG ‑psPhase ‑osOutFile sPart
Library call:
nStatus = TLgetstatex (sPart, sPhase, sOutFile, 0L)
Library call:
nStatus = TLgetstat (sPart, sPhase, sOutFile)
Scripting call:
sOutFile = GetLog (sLocation)
[Note] Note

The TLgetstat library call is deprecated and may not be supported in future versions of the API.


Retrieve the composition log from a partition and store it in a text file.



The path of the partition from which to retrieve the composition log. The scripting call uses the Partition property to determine the partition to use.


The phase from which to retrieve the data. The scripting call uses the Phase property to determine the phase to use.


The full pathname of a document file to hold the retrieved status file. If the file already exists, it will be replaced by the retrieved data. If the file does not exist, it will be created.


This applies to the scripting call only. It determines where the log file is created:

  • If null or the empty string, the file is created in a directory designated for temporary files.

  • If it is the path to an existing directory, the file is created in this directory.

  • Otherwise, the file is created using sLocation as a path. Any existing file with this path will be overwritten.

For additional command line arguments see “Common Flag Arguments”.

Scripting Call Return

The return value is a string containing the path to the log file. This is always an absolute path. It is also available as the value of the OutputFile property.

If the log cannot be generated, an empty string is returned.


Command line:

tlapi ‑cGETLOG ‑pUPDATE ‑oC:\stat.dat manuals/topix/volume1

Library call:

stat = TLgetstat("manuals/topix/volume1", "UPDATE", "C:\\stat.dat");

Scripting call:

file = topleaf.GetLog("C:\\Temp");