  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The LogGetMessage function retrieves the string associated with a specific log message.
Syntax/Parameters
Syntax
string = LogGetMessage ( [handle hLogObject], int index );
Parameters
hLogObject
A handle to a Log Object created with the LogCreate function. If this handle is omitted or NULL_HANDLE is specified, the function will obtain the error string from the default log.
index
An int that specifies the zero-based index of the message. The LogGetMessageCount function with a parameter of LOG_NONE can be used to retrieve the total number of messages, which is the upper limit of the index.
Return Value
Returns a string containing the message or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
An indent in the form of spaces can precede the text data of the string. Use the TrimPadding function to remove leading spaces.
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.