StringWriter Object

Overview

A StringWriter is a CSPro logic object that supports building strings incrementally. Several write functions exist that add to the object's string buffer, either by writing text directly or by writing encoded text. Using a StringWriter is simpler, and more efficient, than concatenating many strings together.

The Report object, referring to a templated report, is a kind of StringWriter, and QSF, the special name used to write to question text, is also a kind of StringWriter.

Functionality

A StringWriter is a CSPro logic object and the following functions can be called via dot notation:

Function	Description
clear	Clears the contents of the string buffer, resetting the buffer to a blank string.
toString	Returns the current contents of the string buffer.
write	Writes text to the string buffer without encoding.
writeEncoded	Writes text to the string buffer with encoding.
writeEncodedLine	Writes text and a newline to the string buffer with encoding.
writeLine	Writes text and a newline to the string buffer without encoding.

getLabel	Returns the symbol's label.
getName	Returns the symbol's name.
getJson	Returns the symbol's metadata and value represented in JSON.
getValueJson	Returns the symbol's value represented in JSON.
setValueFromJson	Modifies the symbol based on a JSON representation of the value.

Assignments

When a StringWriter, or a Report or QSF, is used as an argument to a user-defined function, it is passed by reference. The StringWriter parameter will assume the encoding type of the object passed to the function as an argument.

Conversions

StringWriter objects can be converted to and from JSON strings.

Example

StringWriter sw;

do numeric ctr = 1 while ctr <= 3
sw.writeLine("Random number #%d: %d", ctr, random(0, 100));
enddo;

// the result may look like:
errmsg("%s", sw.toString()); // Random number #1: 71
// Random number #2: 89
// Random number #3: 55

See also: String Statement, Templated Reports