Json::Reader Class Reference

Unserialize a JSON document into a Value. More...

#include <jsoncpp/include/json/reader.h>

List of all members.

Classes
class	ErrorInfo
class	Token
Public Types
typedef char	Char
typedef const Char *	Location
Public Member Functions
bool	parse (const std::string &document, Value &root, bool collectComments=true)
	Read a Value from a JSON document.
bool	parse (const char *beginDoc, const char *endDoc, Value &root, bool collectComments=true)
	Read a Value from a JSON document.
bool	parse (std::istream &, Value &root, bool collectComments=true)
	Parse from input stream.
std::string	getFormatedErrorMessages () const
	Returns a user friendly string that list errors in the parsed document.

---

Detailed Description

Unserialize a JSON document into a Value.

---

Member Function Documentation

std::string Json::Reader::getFormatedErrorMessages

(

)

const

Returns a user friendly string that list errors in the parsed document.

Returns:

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.

bool Json::Reader::parse	(	std::istream &	sin,
		Value &	root,
		bool	collectComments = true
	)

Parse from input stream.

See also:

Json::operator>>(std::istream&, Json::Value&).

bool Json::Reader::parse	(	const char *	beginDoc,
		const char *	endDoc,
		Value &	root,
		bool	collectComments = true
	)

Read a Value from a JSON document.

Parameters:

	document	UTF-8 encoded string containing the document to read.
	root	[out] Contains the root value of the document if it was successfully parsed.
	collectComments	true to collect comment and allow writing them back during serialization, false to discard comments.

Returns:

true if the document was successfully parsed, false if an error occurred.

bool Json::Reader::parse	(	const std::string &	document,
		Value &	root,
		bool	collectComments = true
	)

Read a Value from a JSON document.

Parameters:

	document	UTF-8 encoded string containing the document to read.
	root	[out] Contains the root value of the document if it was successfully parsed.
	collectComments	true to collect comment and allow writing them back during serialization, false to discard comments.

Returns:

true if the document was successfully parsed, false if an error occurred.

---

The documentation for this class was generated from the following files:

• jsoncpp/include/json/reader.h
• jsoncpp/src/lib_json/json_reader.cpp