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 to_lower_copy</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="../../string_algo/reference.html#header.boost.algorithm.string.case_conv_hpp" title="Header <boost/algorithm/string/case_conv.hpp>"> 10<link rel="prev" href="../../string_algo/reference.html" title="Reference"> 11<link rel="next" href="to_lower.html" title="Function template to_lower"> 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="../../string_algo/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.case_conv_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="to_lower.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.algorithm.to_lower_copy"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Function to_lower_copy</span></h2> 30<p>boost::algorithm::to_lower_copy — Convert to lower case. </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="../../string_algo/reference.html#header.boost.algorithm.string.case_conv_hpp" title="Header <boost/algorithm/string/case_conv.hpp>">boost/algorithm/string/case_conv.hpp</a>> 34 35</span> 36<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OutputIteratorT<span class="special">,</span> <span class="keyword">typename</span> RangeT<span class="special">></span> 37 <span class="identifier">OutputIteratorT</span> 38 <span class="identifier">to_lower_copy</span><span class="special">(</span><span class="identifier">OutputIteratorT</span> Output<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RangeT</span> <span class="special">&</span> Input<span class="special">,</span> 39 <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> 40<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SequenceT<span class="special">></span> 41 <span class="identifier">SequenceT</span> <span class="identifier">to_lower_copy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SequenceT</span> <span class="special">&</span> Input<span class="special">,</span> 42 <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> 43<div class="refsect1"> 44<a name="id-1.3.3.9.3.4.4"></a><h2>Description</h2> 45<p>Each element of the input sequence is converted to lower case. The result is a copy of the input converted to lower case. It is returned as a sequence or copied to the output iterator.</p> 46<p> 47 48</p> 49<div class="note"><table border="0" summary="Note"> 50<tr> 51<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> 52<th align="left">Note</th> 53</tr> 54<tr><td align="left" valign="top"><p>The second variant of this function provides the strong exception-safety guarantee </p></td></tr> 55</table></div> 56<p> 57</p> 58<div class="variablelist"><table border="0" class="variablelist compact"> 59<colgroup> 60<col align="left" valign="top"> 61<col> 62</colgroup> 63<tbody> 64<tr> 65<td><p><span class="term">Parameters:</span></p></td> 66<td><div class="variablelist"><table border="0" class="variablelist compact"> 67<colgroup> 68<col align="left" valign="top"> 69<col> 70</colgroup> 71<tbody> 72<tr> 73<td><p><span class="term"><code class="computeroutput">Input</code></span></p></td> 74<td><p>An input range </p></td> 75</tr> 76<tr> 77<td><p><span class="term"><code class="computeroutput">Loc</code></span></p></td> 78<td><p>A locale used for conversion </p></td> 79</tr> 80<tr> 81<td><p><span class="term"><code class="computeroutput">Output</code></span></p></td> 82<td><p>An output iterator to which the result will be copied </p></td> 83</tr> 84</tbody> 85</table></div></td> 86</tr> 87<tr> 88<td><p><span class="term">Returns:</span></p></td> 89<td><p>An output iterator pointing just after the last inserted character or a copy of the input</p></td> 90</tr> 91</tbody> 92</table></div> 93</div> 94</div> 95<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 96<td align="left"></td> 97<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost 98 Software License, Version 1.0. (See accompanying file 99 <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 100 </p> 101</div></td> 102</tr></table> 103<hr> 104<div class="spirit-nav"> 105<a accesskey="p" href="../../string_algo/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.case_conv_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="to_lower.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 106</div> 107</body> 108</html> 109
