diff options
Diffstat (limited to 'doc/html/boost/property_tree/xml_parser/read_xml_idp97121920.html')
| -rw-r--r-- | doc/html/boost/property_tree/xml_parser/read_xml_idp97121920.html | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/doc/html/boost/property_tree/xml_parser/read_xml_idp97121920.html b/doc/html/boost/property_tree/xml_parser/read_xml_idp97121920.html new file mode 100644 index 0000000000..9aa41a1a0f --- /dev/null +++ b/doc/html/boost/property_tree/xml_parser/read_xml_idp97121920.html @@ -0,0 +1,124 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Function template read_xml</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.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>"> +<link rel="prev" href="read_xml_idp209304704.html" title="Function template read_xml"> +<link rel="next" href="write_xml_idp222722464.html" title="Function template write_xml"> +</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="read_xml_idp209304704.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_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="write_xml_idp222722464.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.property_tree.xml_parser.read_xml_idp97121920"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template read_xml</span></h2> +<p>boost::property_tree::xml_parser::read_xml</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.xml_parser_hpp" title="Header <boost/property_tree/xml_parser.hpp>">boost/property_tree/xml_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_xml</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> filename<span class="special">,</span> <span class="identifier">Ptree</span> <span class="special">&</span> pt<span class="special">,</span> <span class="keyword">int</span> flags <span class="special">=</span> <span class="number">0</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp345940176"></a><h2>Description</h2> +<p>Reads XML from a file using the given locale and translates it to 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>XML attributes are placed under keys named <code class="computeroutput"><xmlattr></code>. </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">filename</code></span></p></td> +<td><p>The file from which to read in the property tree. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> +<td> +<p>Flags controlling the bahviour of the parser. The following flags are supported: </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="computeroutput">no_concat_text</code> <span style="color: red"><ndash></ndash></span> Prevents concatenation of text nodes into datastring of property tree. Puts them in separate <code class="computeroutput"><xmltext></code> strings instead. </p></li> +<li class="listitem"><p><code class="computeroutput">no_comments</code> <span style="color: red"><ndash></ndash></span> Skip XML comments. </p></li> +</ul></div> +<p> +</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">loc</code></span></p></td> +<td><p>The locale to use when reading in the file contents. </p></td> +</tr> +<tr> +<td><p><span class="term"><code class="computeroutput">pt</code></span></p></td> +<td><p>The property tree to populate. </p></td> +</tr> +</tbody> +</table></div></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>xml_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="read_xml_idp209304704.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../property_tree/reference.html#header.boost.property_tree.xml_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="write_xml_idp222722464.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |