1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Function template save</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header <boost/property_tree/ptree_serialization.hpp>"> 10<link rel="prev" href="swap.html" title="Function template swap"> 11<link rel="next" href="load.html" title="Function template load"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="swap.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_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="load.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.property_tree.save"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Function template save</span></h2> 30<p>boost::property_tree::save</p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<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.ptree_serialization_hpp" title="Header <boost/property_tree/ptree_serialization.hpp>">boost/property_tree/ptree_serialization.hpp</a>> 34 35</span> 36<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Archive<span class="special">,</span> <span class="keyword">typename</span> K<span class="special">,</span> <span class="keyword">typename</span> D<span class="special">,</span> <span class="keyword">typename</span> C<span class="special">></span> 37 <span class="keyword">void</span> <span class="identifier">save</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&</span> ar<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="basic_ptree.html" title="Class template basic_ptree">basic_ptree</a><span class="special"><</span> <span class="identifier">K</span><span class="special">,</span> <span class="identifier">D</span><span class="special">,</span> <span class="identifier">C</span> <span class="special">></span> <span class="special">&</span> t<span class="special">,</span> 38 <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> file_version<span class="special">)</span><span class="special">;</span></pre></div> 39<div class="refsect1"> 40<a name="id-1.3.32.10.9.3.4"></a><h2>Description</h2> 41<p>Serialize the property tree to the given archive. </p> 42<div class="note"><table border="0" summary="Note"> 43<tr> 44<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> 45<th align="left">Note</th> 46</tr> 47<tr><td align="left" valign="top"><p>In addition to serializing to regular archives, this supports serializing to archives requiring name-value pairs, e.g. XML archives. However, the output format in the XML archive is not guaranteed to be the same as that when using the Boost.PropertyTree library's <code class="computeroutput">boost::property_tree::xml_parser::write_xml</code>. </p></td></tr> 48</table></div> 49<p> 50 51 52</p> 53<div class="variablelist"><table border="0" class="variablelist compact"> 54<colgroup> 55<col align="left" valign="top"> 56<col> 57</colgroup> 58<tbody> 59<tr> 60<td><p><span class="term">Parameters:</span></p></td> 61<td><div class="variablelist"><table border="0" class="variablelist compact"> 62<colgroup> 63<col align="left" valign="top"> 64<col> 65</colgroup> 66<tbody> 67<tr> 68<td><p><span class="term"><code class="computeroutput">ar</code></span></p></td> 69<td><p>The archive to which to save the serialized property tree. This archive should conform to the concept laid out by the Boost.Serialization library. </p></td> 70</tr> 71<tr> 72<td><p><span class="term"><code class="computeroutput">file_version</code></span></p></td> 73<td><p>file_version for the archive. </p></td> 74</tr> 75<tr> 76<td><p><span class="term"><code class="computeroutput">t</code></span></p></td> 77<td><p>The property tree to serialize. </p></td> 78</tr> 79</tbody> 80</table></div></td> 81</tr> 82<tr> 83<td><p><span class="term">Postconditions:</span></p></td> 84<td><p><code class="computeroutput">ar</code> will contain the serialized form of <code class="computeroutput">t</code>. </p></td> 85</tr> 86</tbody> 87</table></div> 88</div> 89</div> 90<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 91<td align="left"></td> 92<td align="right"><div class="copyright-footer">Copyright © 2008-2010 Marcin Kalicinski<br>Copyright © 2010-2013 Sebastian 93 Redl<p> 94 Distributed under the Boost Software License, Version 1.0. (See accompanying 95 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>) 96 </p> 97</div></td> 98</tr></table> 99<hr> 100<div class="spirit-nav"> 101<a accesskey="p" href="swap.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_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="load.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 102</div> 103</body> 104</html> 105
