  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The LogToText function copies the contents of a log into an text string.
Syntax/Parameters
Syntax
string = LogToText ( [handle hLog], [boolean newlines] );
Parameters
hLogObject
An optional handle to a Log Object created with the LogCreate function. If this handle is omitted or NULL_HANDLE is specified, the function will apply the error summary to the default log.
newlines
An optional boolean flag indicating to add new line characters to each line ending. The default value is FALSE.
Return Value
Returns a string containing a text rendering of the log or an empty string on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
The text encoding is the same as the data within the log.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.