<html> <head> <title> JsonCpp - JSON data format manipulation library </title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head> <body bgcolor="#ffffff"> <table width="100%"> <tr> <td width="40%" align="left" valign="center"> <a href="https://github.com/open-source-parsers/jsoncpp"> JsonCpp project page </a> </td> <td width="40%" align="right" valign="center"> <a href="http://open-source-parsers.github.io/jsoncpp-docs/doxygen/">JsonCpp home page</a> </td> </tr> </table> <hr> <!-- Generated by Doxygen 1.8.8 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_json.html">Json</a></li><li class="navelem"><a class="el" href="class_json_1_1_reader.html">Reader</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="class_json_1_1_reader-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Json::Reader Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Unserialize a <a href="http://www.json.org">JSON</a> document into a <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a>. <a href="class_json_1_1_reader.html#details">More...</a></p> <p><code>#include <<a class="el" href="reader_8h_source.html">/home/iurt/rpmbuild/BUILD/jsoncpp-1.6.5/include/json/reader.h</a>></code></p> <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Json::Reader:</div> <div id="dynsection-0-summary" class="dynsummary" style="display:block;"> </div> <div id="dynsection-0-content" class="dyncontent" style="display:none;"> <div class="center"><img src="class_json_1_1_reader__coll__graph.png" border="0" usemap="#_json_1_1_reader_coll__map" alt="Collaboration graph"/></div> <map name="_json_1_1_reader_coll__map" id="_json_1_1_reader_coll__map"> </map> </div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_json_1_1_reader_1_1_structured_error.html">StructuredError</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An error tagged with where in the JSON text it was encountered. <a href="struct_json_1_1_reader_1_1_structured_error.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a3eec9118f3e9a672ba8348c3a79d0f45"><td class="memItemLeft" align="right" valign="top">typedef char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a3eec9118f3e9a672ba8348c3a79d0f45">Char</a></td></tr> <tr class="separator:a3eec9118f3e9a672ba8348c3a79d0f45"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a46795b5b272bf79a7730e406cb96375a"><td class="memItemLeft" align="right" valign="top">typedef const <a class="el" href="class_json_1_1_reader.html#a3eec9118f3e9a672ba8348c3a79d0f45">Char</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a46795b5b272bf79a7730e406cb96375a">Location</a></td></tr> <tr class="separator:a46795b5b272bf79a7730e406cb96375a"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a0b3c4e24c8393354bab57a6ba3ffc27f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a0b3c4e24c8393354bab57a6ba3ffc27f">Reader</a> ()</td></tr> <tr class="memdesc:a0b3c4e24c8393354bab57a6ba3ffc27f"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="class_json_1_1_reader.html" title="Unserialize a JSON document into a Value. ">Reader</a> allowing all features for parsing. <a href="#a0b3c4e24c8393354bab57a6ba3ffc27f">More...</a><br /></td></tr> <tr class="separator:a0b3c4e24c8393354bab57a6ba3ffc27f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a45f17831118337309180313e93ac33f8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a45f17831118337309180313e93ac33f8">Reader</a> (const <a class="el" href="class_json_1_1_features.html">Features</a> &features)</td></tr> <tr class="memdesc:a45f17831118337309180313e93ac33f8"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="class_json_1_1_reader.html" title="Unserialize a JSON document into a Value. ">Reader</a> allowing the specified feature set for parsing. <a href="#a45f17831118337309180313e93ac33f8">More...</a><br /></td></tr> <tr class="separator:a45f17831118337309180313e93ac33f8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af1da6c976ad1e96c742804c3853eef94"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#af1da6c976ad1e96c742804c3853eef94">parse</a> (const std::string &document, <a class="el" href="class_json_1_1_value.html">Value</a> &root, bool collectComments=true)</td></tr> <tr class="memdesc:af1da6c976ad1e96c742804c3853eef94"><td class="mdescLeft"> </td><td class="mdescRight">Read a <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> from a <a href="http://www.json.org">JSON</a> document. <a href="#af1da6c976ad1e96c742804c3853eef94">More...</a><br /></td></tr> <tr class="separator:af1da6c976ad1e96c742804c3853eef94"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac71ef2b64c7c27b062052e692af3fb32"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#ac71ef2b64c7c27b062052e692af3fb32">parse</a> (const char *beginDoc, const char *endDoc, <a class="el" href="class_json_1_1_value.html">Value</a> &root, bool collectComments=true)</td></tr> <tr class="memdesc:ac71ef2b64c7c27b062052e692af3fb32"><td class="mdescLeft"> </td><td class="mdescRight">Read a <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> from a <a href="http://www.json.org">JSON</a> document. <a href="#ac71ef2b64c7c27b062052e692af3fb32">More...</a><br /></td></tr> <tr class="separator:ac71ef2b64c7c27b062052e692af3fb32"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8d0347e6b47343e4bc68be7ecdb9c4e9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a8d0347e6b47343e4bc68be7ecdb9c4e9">parse</a> (std::istream &is, <a class="el" href="class_json_1_1_value.html">Value</a> &root, bool collectComments=true)</td></tr> <tr class="memdesc:a8d0347e6b47343e4bc68be7ecdb9c4e9"><td class="mdescLeft"> </td><td class="mdescRight">Parse from input stream. <a href="#a8d0347e6b47343e4bc68be7ecdb9c4e9">More...</a><br /></td></tr> <tr class="separator:a8d0347e6b47343e4bc68be7ecdb9c4e9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afa4a59e962d23c4d1c38b433fc95eefa"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#afa4a59e962d23c4d1c38b433fc95eefa">getFormatedErrorMessages</a> () const </td></tr> <tr class="memdesc:afa4a59e962d23c4d1c38b433fc95eefa"><td class="mdescLeft"> </td><td class="mdescRight">Returns a user friendly string that list errors in the parsed document. <a href="#afa4a59e962d23c4d1c38b433fc95eefa">More...</a><br /></td></tr> <tr class="separator:afa4a59e962d23c4d1c38b433fc95eefa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a95ab50aa789132e9dee0fc1475c85acf"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a95ab50aa789132e9dee0fc1475c85acf">getFormattedErrorMessages</a> () const </td></tr> <tr class="memdesc:a95ab50aa789132e9dee0fc1475c85acf"><td class="mdescLeft"> </td><td class="mdescRight">Returns a user friendly string that list errors in the parsed document. <a href="#a95ab50aa789132e9dee0fc1475c85acf">More...</a><br /></td></tr> <tr class="separator:a95ab50aa789132e9dee0fc1475c85acf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a08c2ea5ffc7d2a9c9e35020835624f0b"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="struct_json_1_1_reader_1_1_structured_error.html">StructuredError</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a08c2ea5ffc7d2a9c9e35020835624f0b">getStructuredErrors</a> () const </td></tr> <tr class="memdesc:a08c2ea5ffc7d2a9c9e35020835624f0b"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector of structured erros encounted while parsing. <a href="#a08c2ea5ffc7d2a9c9e35020835624f0b">More...</a><br /></td></tr> <tr class="separator:a08c2ea5ffc7d2a9c9e35020835624f0b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ade6c28e0ef00d8f2e0aa2283f91c3e37"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#ade6c28e0ef00d8f2e0aa2283f91c3e37">pushError</a> (const <a class="el" href="class_json_1_1_value.html">Value</a> &value, const std::string &message)</td></tr> <tr class="memdesc:ade6c28e0ef00d8f2e0aa2283f91c3e37"><td class="mdescLeft"> </td><td class="mdescRight">Add a semantic error message. <a href="#ade6c28e0ef00d8f2e0aa2283f91c3e37">More...</a><br /></td></tr> <tr class="separator:ade6c28e0ef00d8f2e0aa2283f91c3e37"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9b474233c3a7c688e340e70665d45223"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a9b474233c3a7c688e340e70665d45223">pushError</a> (const <a class="el" href="class_json_1_1_value.html">Value</a> &value, const std::string &message, const <a class="el" href="class_json_1_1_value.html">Value</a> &extra)</td></tr> <tr class="memdesc:a9b474233c3a7c688e340e70665d45223"><td class="mdescLeft"> </td><td class="mdescRight">Add a semantic error message with extra context. <a href="#a9b474233c3a7c688e340e70665d45223">More...</a><br /></td></tr> <tr class="separator:a9b474233c3a7c688e340e70665d45223"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a06b52dcc656549506b1ae6f05167ecf4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_reader.html#a06b52dcc656549506b1ae6f05167ecf4">good</a> () const </td></tr> <tr class="memdesc:a06b52dcc656549506b1ae6f05167ecf4"><td class="mdescLeft"> </td><td class="mdescRight">Return whether there are any errors. <a href="#a06b52dcc656549506b1ae6f05167ecf4">More...</a><br /></td></tr> <tr class="separator:a06b52dcc656549506b1ae6f05167ecf4"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Unserialize a <a href="http://www.json.org">JSON</a> document into a <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a>. </p> <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_json_1_1_char_reader.html" title="Interface for reading JSON from a char array. ">CharReader</a> and <a class="el" href="class_json_1_1_char_reader_builder.html" title="Build a CharReader implementation. ">CharReaderBuilder</a>. </dd></dl> <p>Definition at line <a class="el" href="reader_8h_source.html#l00033">33</a> of file <a class="el" href="reader_8h_source.html">reader.h</a>.</p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a class="anchor" id="a3eec9118f3e9a672ba8348c3a79d0f45"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef char <a class="el" href="class_json_1_1_reader.html#a3eec9118f3e9a672ba8348c3a79d0f45">Json::Reader::Char</a></td> </tr> </table> </div><div class="memdoc"> <p>Definition at line <a class="el" href="reader_8h_source.html#l00035">35</a> of file <a class="el" href="reader_8h_source.html">reader.h</a>.</p> </div> </div> <a class="anchor" id="a46795b5b272bf79a7730e406cb96375a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef const <a class="el" href="class_json_1_1_reader.html#a3eec9118f3e9a672ba8348c3a79d0f45">Char</a>* <a class="el" href="class_json_1_1_reader.html#a46795b5b272bf79a7730e406cb96375a">Json::Reader::Location</a></td> </tr> </table> </div><div class="memdoc"> <p>Definition at line <a class="el" href="reader_8h_source.html#l00036">36</a> of file <a class="el" href="reader_8h_source.html">reader.h</a>.</p> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a0b3c4e24c8393354bab57a6ba3ffc27f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Json::Reader::Reader </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a <a class="el" href="class_json_1_1_reader.html" title="Unserialize a JSON document into a Value. ">Reader</a> allowing all features for parsing. </p> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00072">72</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> </div> </div> <a class="anchor" id="a45f17831118337309180313e93ac33f8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Json::Reader::Reader </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_json_1_1_features.html">Features</a> & </td> <td class="paramname"><em>features</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a <a class="el" href="class_json_1_1_reader.html" title="Unserialize a JSON document into a Value. ">Reader</a> allowing the specified feature set for parsing. </p> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00077">77</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="afa4a59e962d23c4d1c38b433fc95eefa"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Json::Reader::getFormatedErrorMessages </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns a user friendly string that list errors in the parsed document. </p> <dl class="section return"><dt>Returns</dt><dd>Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing. </dd></dl> <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Use <a class="el" href="class_json_1_1_reader.html#a95ab50aa789132e9dee0fc1475c85acf" title="Returns a user friendly string that list errors in the parsed document. ">getFormattedErrorMessages()</a> instead (typo fix). </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00809">809</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> <p>References <a class="el" href="json__reader_8cpp_source.html#l00813">getFormattedErrorMessages()</a>.</p> </div> </div> <a class="anchor" id="a95ab50aa789132e9dee0fc1475c85acf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string Json::Reader::getFormattedErrorMessages </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns a user friendly string that list errors in the parsed document. </p> <dl class="section return"><dt>Returns</dt><dd>Formatted error message with the list of errors with their location in the parsed document. An empty string is returned if no error occurred during parsing. </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00813">813</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> <p>Referenced by <a class="el" href="json__reader_8cpp_source.html#l00809">getFormatedErrorMessages()</a>.</p> <p><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div> <div id="dynsection-1-summary" class="dynsummary" style="display:block;"> </div> <div id="dynsection-1-content" class="dyncontent" style="display:none;"> <div class="center"><img src="class_json_1_1_reader_a95ab50aa789132e9dee0fc1475c85acf_icgraph.png" border="0" usemap="#class_json_1_1_reader_a95ab50aa789132e9dee0fc1475c85acf_icgraph" alt=""/></div> <map name="class_json_1_1_reader_a95ab50aa789132e9dee0fc1475c85acf_icgraph" id="class_json_1_1_reader_a95ab50aa789132e9dee0fc1475c85acf_icgraph"> <area shape="rect" id="node2" href="class_json_1_1_reader.html#afa4a59e962d23c4d1c38b433fc95eefa" title="Returns a user friendly string that list errors in the parsed document. " alt="" coords="336,5,608,47"/></map> </div> </p> </div> </div> <a class="anchor" id="a08c2ea5ffc7d2a9c9e35020835624f0b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::vector< <a class="el" href="struct_json_1_1_reader_1_1_structured_error.html">Reader::StructuredError</a> > Json::Reader::getStructuredErrors </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns a vector of structured erros encounted while parsing. </p> <dl class="section return"><dt>Returns</dt><dd>A (possibly empty) vector of <a class="el" href="struct_json_1_1_reader_1_1_structured_error.html" title="An error tagged with where in the JSON text it was encountered. ">StructuredError</a> objects. Currently only one error can be returned, but the caller should tolerate multiple errors. This can occur if the parser recovers from a non-fatal parse error and then encounters additional errors. </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00829">829</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> <p>References <a class="el" href="reader_8h_source.html#l00047">Json::Reader::StructuredError::message</a>, <a class="el" href="reader_8h_source.html#l00046">Json::Reader::StructuredError::offset_limit</a>, and <a class="el" href="reader_8h_source.html#l00045">Json::Reader::StructuredError::offset_start</a>.</p> </div> </div> <a class="anchor" id="a06b52dcc656549506b1ae6f05167ecf4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Json::Reader::good </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Return whether there are any errors. </p> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if there are no errors to report <code>false</code> if errors have occurred. </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00879">879</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> </div> </div> <a class="anchor" id="af1da6c976ad1e96c742804c3853eef94"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Json::Reader::parse </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>document</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="class_json_1_1_value.html">Value</a> & </td> <td class="paramname"><em>root</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>collectComments</em> = <code>true</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Read a <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> from a <a href="http://www.json.org">JSON</a> document. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">document</td><td>UTF-8 encoded string containing the document to read. </td></tr> <tr><td class="paramname">root</td><td>[out] Contains the root value of the document if it was successfully parsed. </td></tr> <tr><td class="paramname">collectComments</td><td><code>true</code> to collect comment and allow writing them back during serialization, <code>false</code> to discard comments. This parameter is ignored if <a class="el" href="class_json_1_1_features.html#a33afd389719624b6bdb23950b3c346c9" title="true if comments are allowed. Default: true. ">Features::allowComments_</a> is <code>false</code>. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the document was successfully parsed, <code>false</code> if an error occurred. </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00083">83</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> <p>Referenced by <a class="el" href="json__reader_8cpp_source.html#l00090">parse()</a>.</p> <p><div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> <img id="dynsection-2-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div> <div id="dynsection-2-summary" class="dynsummary" style="display:block;"> </div> <div id="dynsection-2-content" class="dyncontent" style="display:none;"> <div class="center"><img src="class_json_1_1_reader_af1da6c976ad1e96c742804c3853eef94_icgraph.png" border="0" usemap="#class_json_1_1_reader_af1da6c976ad1e96c742804c3853eef94_icgraph" alt=""/></div> <map name="class_json_1_1_reader_af1da6c976ad1e96c742804c3853eef94_icgraph" id="class_json_1_1_reader_af1da6c976ad1e96c742804c3853eef94_icgraph"> <area shape="rect" id="node2" href="class_json_1_1_reader.html#a8d0347e6b47343e4bc68be7ecdb9c4e9" title="Parse from input stream. " alt="" coords="265,5,477,32"/></map> </div> </p> </div> </div> <a class="anchor" id="ac71ef2b64c7c27b062052e692af3fb32"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Json::Reader::parse </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>beginDoc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>endDoc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="class_json_1_1_value.html">Value</a> & </td> <td class="paramname"><em>root</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>collectComments</em> = <code>true</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Read a <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> from a <a href="http://www.json.org">JSON</a> document. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">beginDoc</td><td>Pointer on the beginning of the UTF-8 encoded string of the document to read. </td></tr> <tr><td class="paramname">endDoc</td><td>Pointer on the end of the UTF-8 encoded string of the document to read. Must be >= beginDoc. </td></tr> <tr><td class="paramname">root</td><td>[out] Contains the root value of the document if it was successfully parsed. </td></tr> <tr><td class="paramname">collectComments</td><td><code>true</code> to collect comment and allow writing them back during serialization, <code>false</code> to discard comments. This parameter is ignored if <a class="el" href="class_json_1_1_features.html#a33afd389719624b6bdb23950b3c346c9" title="true if comments are allowed. Default: true. ">Features::allowComments_</a> is <code>false</code>. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the document was successfully parsed, <code>false</code> if an error occurred. </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00103">103</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> <p>References <a class="el" href="features_8h_source.html#l00042">Json::Features::allowComments_</a>, <a class="el" href="value_8h_source.html#l00092">Json::commentAfter</a>, <a class="el" href="json__value_8cpp_source.html#l01290">Json::Value::isArray()</a>, <a class="el" href="json__value_8cpp_source.html#l01292">Json::Value::isObject()</a>, <a class="el" href="json__value_8cpp_source.html#l01304">Json::Value::setComment()</a>, <a class="el" href="json__reader_8cpp_source.html#l00031">stackDepth_g</a>, and <a class="el" href="features_8h_source.html#l00046">Json::Features::strictRoot_</a>.</p> </div> </div> <a class="anchor" id="a8d0347e6b47343e4bc68be7ecdb9c4e9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Json::Reader::parse </td> <td>(</td> <td class="paramtype">std::istream & </td> <td class="paramname"><em>is</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="class_json_1_1_value.html">Value</a> & </td> <td class="paramname"><em>root</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>collectComments</em> = <code>true</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Parse from input stream. </p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_json.html#a4d245ef719cc0853e8e78eb5f99c16e5" title="Read from 'sin' into 'root'. ">Json::operator>>(std::istream&, Json::Value&)</a>. </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00090">90</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> <p>References <a class="el" href="json__reader_8cpp_source.html#l00083">parse()</a>.</p> </div> </div> <a class="anchor" id="ade6c28e0ef00d8f2e0aa2283f91c3e37"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Json::Reader::pushError </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_json_1_1_value.html">Value</a> & </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>message</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Add a semantic error message. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>JSON <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> location associated with the error </td></tr> <tr><td class="paramname">message</td><td>The error message. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the error was successfully added, <code>false</code> if the <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> offset exceeds the document size. </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00844">844</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> <p>References <a class="el" href="json__value_8cpp_source.html#l01328">Json::Value::getOffsetLimit()</a>, and <a class="el" href="json__value_8cpp_source.html#l01326">Json::Value::getOffsetStart()</a>.</p> </div> </div> <a class="anchor" id="a9b474233c3a7c688e340e70665d45223"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Json::Reader::pushError </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_json_1_1_value.html">Value</a> & </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>message</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="class_json_1_1_value.html">Value</a> & </td> <td class="paramname"><em>extra</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Add a semantic error message with extra context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value</td><td>JSON <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> location associated with the error </td></tr> <tr><td class="paramname">message</td><td>The error message. </td></tr> <tr><td class="paramname">extra</td><td>Additional JSON <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> location to contextualize the error </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if the error was successfully added, <code>false</code> if either <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a> offset exceeds the document size. </dd></dl> <p>Definition at line <a class="el" href="json__reader_8cpp_source.html#l00861">861</a> of file <a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a>.</p> <p>References <a class="el" href="json__value_8cpp_source.html#l01328">Json::Value::getOffsetLimit()</a>, and <a class="el" href="json__value_8cpp_source.html#l01326">Json::Value::getOffsetStart()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>/home/iurt/rpmbuild/BUILD/jsoncpp-1.6.5/include/json/<a class="el" href="reader_8h_source.html">reader.h</a></li> <li>/home/iurt/rpmbuild/BUILD/jsoncpp-1.6.5/src/lib_json/<a class="el" href="json__reader_8cpp_source.html">json_reader.cpp</a></li> </ul> </div><!-- contents --> <hr> </body> </html>