1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function template convert</title> 5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../index.html" title="Chapter 1. Boost.Convert 2.0"> 8<link rel="up" href="../boost_convert_c___reference.html#header.boost.convert_hpp" title="Header <boost/convert.hpp>"> 9<link rel="prev" href="throw_on_failure.html" title="Global throw_on_failure"> 10<link rel="next" href="convert_idm45934319972896.html" title="Function template convert"> 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="throw_on_failure.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost_convert_c___reference.html#header.boost.convert_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="convert_idm45934319972896.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.convert_idm45934319980144"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function template convert</span></h2> 29<p>boost::convert — Boost.Convert main deployment interface. </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: <<a class="link" href="../boost_convert_c___reference.html#header.boost.convert_hpp" title="Header <boost/convert.hpp>">boost/convert.hpp</a>> 33 34</span> 35<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> TypeOut<span class="special">,</span> <span class="keyword">typename</span> TypeIn<span class="special">,</span> <span class="keyword">typename</span> Converter<span class="special">></span> 36 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span> <span class="identifier">TypeOut</span> <span class="special">></span> 37 <span class="identifier">convert</span><span class="special">(</span><span class="identifier">TypeIn</span> <span class="keyword">const</span> <span class="special">&</span> value_in<span class="special">,</span> <span class="identifier">Converter</span> <span class="keyword">const</span> <span class="special">&</span> converter<span class="special">)</span><span class="special">;</span></pre></div> 38<div class="refsect1"> 39<a name="idm45766274047664"></a><h2>Description</h2> 40<p> 41 42For example, </p> 43<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">cnv</span><span class="special">::</span><span class="identifier">cstream</span> <span class="identifier">cnv</span><span class="special">;</span> 44 45<span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">i</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">convert</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span><span class="special">(</span><span class="string">"12"</span><span class="special">,</span> <span class="identifier">cnv</span><span class="special">)</span><span class="special">;</span> 46<span class="identifier">boost</span><span class="special">::</span><span class="identifier">optional</span><span class="special"><</span><span class="identifier">string</span><span class="special">></span> <span class="identifier">s</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">convert</span><span class="special"><</span><span class="identifier">string</span><span class="special">></span><span class="special">(</span><span class="number">123</span><span class="special">.</span><span class="number">456</span><span class="special">,</span> <span class="identifier">cnv</span><span class="special">)</span><span class="special">;</span> 47</pre> 48<p> </p> 49<div class="variablelist"><table border="0" class="variablelist compact"> 50<colgroup> 51<col align="left" valign="top"> 52<col> 53</colgroup> 54<tbody> 55<tr> 56<td><p><span class="term">Parameters:</span></p></td> 57<td><div class="variablelist"><table border="0" class="variablelist compact"> 58<colgroup> 59<col align="left" valign="top"> 60<col> 61</colgroup> 62<tbody> 63<tr> 64<td><p><span class="term"><code class="computeroutput">converter</code></span></p></td> 65<td><p>Converter to be used for conversion </p></td> 66</tr> 67<tr> 68<td><p><span class="term"><code class="computeroutput">value_in</code></span></p></td> 69<td><p>Value of the TypeIn type to be converted to the TypeOut type </p></td> 70</tr> 71</tbody> 72</table></div></td> 73</tr> 74<tr> 75<td><p><span class="term">Returns:</span></p></td> 76<td><p>boost::optional<TypeOut> result of conversion together with the indication of success or failure of the conversion request.</p></td> 77</tr> 78</tbody> 79</table></div> 80</div> 81</div> 82<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 83<td align="left"></td> 84<td align="right"><div class="copyright-footer">Copyright © 2009-2016 Vladimir Batov<p> 85 Distributed under the Boost Software License, Version 1.0. See copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>. 86 </p> 87</div></td> 88</tr></table> 89<hr> 90<div class="spirit-nav"> 91<a accesskey="p" href="throw_on_failure.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost_convert_c___reference.html#header.boost.convert_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="convert_idm45934319972896.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 92</div> 93</body> 94</html> 95
