<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Function template read_json</title> <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>"> <link rel="prev" href="../ini_parser/write_in_idm45507103416992.html" title="Function template write_ini"> <link rel="next" href="read_jso_idm45506991936080.html" title="Function template read_json"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> <td align="center"><a href="../../../../../index.html">Home</a></td> <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="../ini_parser/write_in_idm45507103416992.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_jso_idm45506991936080.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.property_tree.json_parser.read_jso_idm45507048694352"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template read_json</span></h2> <p>boost::property_tree::json_parser::read_json</p> </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp" title="Header <boost/property_tree/json_parser.hpp>">boost/property_tree/json_parser.hpp</a>> </span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Ptree<span class="special">></span> <span class="keyword">void</span> <span class="identifier">read_json</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">Ptree</span><span class="special">::</span><span class="identifier">key_type</span><span class="special">::</span><span class="identifier">value_type</span> <span class="special">></span> <span class="special">&</span> stream<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> <a name="idm45555211984768"></a><h2>Description</h2> <p>Read JSON from a the given stream and translate it to a property tree. </p> <div class="note"><table border="0" summary="Note"> <tr> <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> <th align="left">Note</th> </tr> <tr><td align="left" valign="top"><p>Clears existing contents of property tree. In case of error the property tree unmodified. </p></td></tr> </table></div> <p> </p> <div class="note"><table border="0" summary="Note"> <tr> <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> <th align="left">Note</th> </tr> <tr><td align="left" valign="top"><p>Items of JSON arrays are translated into ptree keys with empty names. Members of objects are translated into named keys. </p></td></tr> </table></div> <p> </p> <div class="note"><table border="0" summary="Note"> <tr> <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td> <th align="left">Note</th> </tr> <tr><td align="left" valign="top"><p>JSON data can be a string, a numeric value, or one of literals "null", "true" and "false". During parse, any of the above is copied verbatim into ptree data string. </p></td></tr> </table></div> <p> </p> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Parameters:</span></p></td> <td><div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> <td><p>The property tree to populate. </p></td> </tr> <tr> <td><p><span class="term"><code class="computeroutput">stream</code></span></p></td> <td><p>Stream from which to read in the property tree. </p></td> </tr> </tbody> </table></div></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>json_parser_error In case of error deserializing the property tree. </td> </tr> </tbody> </table></div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2008-2010 Marcin Kalicinski<br>Copyright © 2010-2013 Sebastian Redl<p> Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) </p> </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="../ini_parser/write_in_idm45507103416992.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.json_parser_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="read_jso_idm45506991936080.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>