Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FiveGeneral Functions (continued)

LogAppendString Function

Overview

The LogAppendString function appends a string to the log, including line breaks.

Syntax/Parameters

Syntax

int = LogAppendLog ( [handle hLogObject], string data );

Parameters

hLogObject

The handle to a Log Object created with the LogCreate function. If no handle is provided, the function will append the string to the default log.

data

A string containing the data to be added to the log.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information.

Remarks

The data is appended to the end of the destination or default log on a line by line basis. This function differs from AddMessage in that line endings (0x0D and 0x0A) are processed as separate log entries.

An indent can be used to further indent the incoming log to allow grouping. For more information on setting log indent levels, see the LogIndent and LogOutdent functions.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic