AppendToReportFile()

Summary

Appends text to the report file.

 

Changes

Added to Version 4.8.

 

Syntax

AppendToReportFile(int IndentLevel, string text [, array options])

 

Argument	Contents
IndentLevel	The indentation level of the text
text	The text of the message to append

 

Options for section links:

 

Options	Type	Contents
Section	Boolean	"True" to add this line as a new section link, "False" (the default) if not a section link
Title	String	The title for a section link

 

Options for non-section links:

 

Options	Type	Contents
Bold	Boolean	"True" to display bold text, otherwise "False" (the default)
Border	Boolean	"True" to display a border around the line, otherwise "False" (the default)
Padding	Integer	The number of pixels to pad the line with
Background	String	"Light" or "Dark" to add shading to the line

 

Notes

• The options array is an optional argument.

• The Title option string is added before the text of the message to append.

• The indentation levels are five spaces each.

 

Example

AppendToReportFile(0, "Iterations", {{"Section", "True"}})

AppendTableToReportFile({{{"Name", "Name"}, {"Percentage Width", 50}, {"Alignment", "Left"}},

{{"Name", "Status"}, {"Percentage Width", 50}, {"Alignment", "Center"}}},

{{"Title", "Output Table"}}) 

AppendRowToReportFile({"First Iteration", "Completed"}, )

AppendRowToReportFile({"Second Iteration", "Converged"}, )

CloseReportFileSection()

 

See Also

Function	Summary
GetReportFileName()	Gets the name of the report file
ResetReportFile()	Empties the report file
SetReportFileName()	Sets the name of the report file