Format the specified object to the specified output stream using the bdlat_FormattingMode::e_TEXT formatting mode.

Synopsis

Declared in <balxml_typesprintutil.h>

template<class TYPE>
static
std::ostream&
printText(
    std::ostream& stream,
    TYPE const& object,
    EncoderOptions const* encoderOptions = 0);

Description

Optionally use the specified encoderOptions. Return a reference to stream. The string representation of object must be a valid UTF‐8 string and may not contain any control characters other than TAB, NL, and CR (i.e., no binary data) unless encoderOptions‐>allowControlCharacters() is true, in which control characters will be encoded as is. Upon detecting an invalid byte, the output stops and the failbit is be set on the output stream. In the case of an invalid byte in a multi‐byte character, the output stops after the previous character and no byte in this character is output.

Return Value

a reference to the modifiable stream

Parameters

Name

Description

stream

output stream to receive the formatted text

object

value to format

encoderOptions

encoding options; null uses defaults

Created with MrDocs