StringWriter.writeLine Function

This documentation also applies to the Report.writeLine function as a Report is a type of StringWriter.

Format 1

b = object_name.writeLine(string_expʃ, argument1, ..., argumentNʅ)

Format 2

b = object_name.writeLine(msg_numʃ, argument1, ..., argumentNʅ)

Description

The StringWriter.writeLine function writes text to a StringWriter object's string buffer (or to a templated report), followed by the newline character '\n'. The text is written without encoding the text for the StringWriter's encoding type or the templated report's format. When used as part of a Report object, the function is meant to be called from within the templated report's logic.

Each argument is sequentially inserted into the string_exp or msg_num. Arguments can be numeric or string expressions, but the type of the argument must match the type of the receiving field in the message text. See Message Formatting Options for a complete list of formatting options.

The following table summarizes the options for writing to a StringWriter:

Function	Text Encoded	Newline Added
write	✘
writeLine	✘	'\n'
writeEncoded	✔
writeEncodedLine	✔	'\n', <br>, etc.

Return Value

The function returns a logical value of 1 (true) if successful and 0 (false) otherwise.

Example 1 (StringWriter)

StringWriter sw_html(HTML);

sw_html.write("Terms ");
sw_html.writeEncoded("& Conditions:");

sw_html.writeLine("");
sw_html.writeEncodedLine("<<< Do not use the application if you do not accept the T&Cs! >>>");
sw_html.writeLine("");

string result = sw_html.toString();

// the result, with HTML encoding:

Terms & Conditions:
<<< Do not use the application if you do not accept the T&Cs! >>>

Example 2 (Report)

<?
HOUSEHOLD_REPORT.writeLine("The report was generated at: ", timestamp());

// alternatively, use $ to refer to HOUSEHOLD_REPORT
$.writeLine("The report was generated at: ", timestamp());
?>

See also: StringWriter Object, Templated Reports