doc/html/boost/property_tree/save_idp216693664.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function template save</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header &lt;boost/property_tree/ptree_serialization.hpp&gt;">
   9 <link rel="prev" href="swap_idp207913264.html" title="Function template swap">
  10 <link rel="next" href="load_idp229842432.html" title="Function template load">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="swap_idp207913264.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_idp229842432.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.property_tree.save_idp216693664"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function template save</span></h2>
  29 <p>boost::property_tree::save</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../property_tree/reference.html#header.boost.property_tree.ptree_serialization_hpp" title="Header &lt;boost/property_tree/ptree_serialization.hpp&gt;">boost/property_tree/ptree_serialization.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
  36   <span class="keyword">void</span> <span class="identifier">save</span><span class="special">(</span><span class="identifier">Archive</span> <span class="special">&amp;</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">&lt;</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">&gt;</span> <span class="special">&amp;</span> t<span class="special">,</span>
  37             <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>
  38 <div class="refsect1">
  39 <a name="idp351632192"></a><h2>Description</h2>
  40 <p>Serialize the property tree to the given archive. </p>
  41 <div class="note"><table border="0" summary="Note">
  42 <tr>
  43 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  44 <th align="left">Note</th>
  45 </tr>
  46 <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>
  47 </table></div>
  48 <p>
  49
  50
  51 </p>
  52 <div class="variablelist"><table border="0" class="variablelist compact">
  53 <colgroup>
  54 <col align="left" valign="top">
  55 <col>
  56 </colgroup>
  57 <tbody>
  58 <tr>
  59 <td><p><span class="term">Parameters:</span></p></td>
  60 <td><div class="variablelist"><table border="0" class="variablelist compact">
  61 <colgroup>
  62 <col align="left" valign="top">
  63 <col>
  64 </colgroup>
  65 <tbody>
  66 <tr>
  67 <td><p><span class="term"><code class="computeroutput">ar</code></span></p></td>
  68 <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>
  69 </tr>
  70 <tr>
  71 <td><p><span class="term"><code class="computeroutput">file_version</code></span></p></td>
  72 <td><p>file_version for the archive. </p></td>
  73 </tr>
  74 <tr>
  75 <td><p><span class="term"><code class="computeroutput">t</code></span></p></td>
  76 <td><p>The property tree to serialize. </p></td>
  77 </tr>
  78 </tbody>
  79 </table></div></td>
  80 </tr>
  81 <tr>
  82 <td><p><span class="term">Postconditions:</span></p></td>
  83 <td><p><code class="computeroutput">ar</code> will contain the serialized form of <code class="computeroutput">t</code>. </p></td>
  84 </tr>
  85 </tbody>
  86 </table></div>
  87 </div>
  88 </div>
  89 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  90 <td align="left"></td>
  91 <td align="right"><div class="copyright-footer">Copyright &#169; 2008 Marcin Kalicinski<p>
  92         Distributed under the Boost Software License, Version 1.0. (See accompanying
  93         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>)
  94       </p>
  95 </div></td>
  96 </tr></table>
  97 <hr>
  98 <div class="spirit-nav">
  99 <a accesskey="p" href="swap_idp207913264.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_idp229842432.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 100 </div>
 101 </body>
 102 </html>