Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Function template write_json

boost::property_tree::json_parser::write_json

Synopsis

// In header: <boost/property_tree/json_parser.hpp>


template<typename Ptree> 
  void write_json(std::basic_ostream< typename Ptree::key_type::value_type > & stream, 
                  const Ptree & pt, bool pretty = true);

Description

Translates the property tree to JSON and writes it the given output stream.

[Note] Note

Any property tree key containing only unnamed subkeys will be rendered as JSON arrays.

Parameters:

pretty

Whether to pretty-print. Defaults to true for backward compatibility.

pt

The property tree to tranlsate to JSON and output.

stream

The stream to which to write the JSON representation of the property tree.

Requires:

pt cannot contain keys that have both subkeys and non-empty data.

Throws:

json_parser_error In case of error translating the property tree to JSON or writing to the output stream.

PrevUpHomeNext