encode overloads

Synopses

Declared in <balxml_encoder.h>

Encode the specified non‐modifiable object to the specified formatter.

template<class TYPE>
int
encode(
    Formatter& formatter,
    TYPE const& object);

» more...

Encode the specified non‐modifiable object to the specified stream.

template<class TYPE>
std::ostream&
encode(
    std::ostream& stream,
    TYPE const& object);

» more...

Encode the specified non‐modifiable object to the specified buffer.

template<class TYPE>
int
encode(
    std::streambuf* buffer,
    TYPE const& object);

» more...

Return Value

  • 0 on success, and a non‐zero value otherwise

  • a reference to the modifiable stream

Parameters

Name

Description

formatter

XML formatter to receive the encoded value

object

value to encode

stream

output stream to receive XML

buffer

output stream buffer to receive XML

Created with MrDocs