Imported Upstream version 1.57.0
[platform/upstream/boost.git] / doc / html / boost / algorithm / trim.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Function template trim</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="../../string_algo/reference.html#header.boost.algorithm.string.trim_hpp" title="Header &lt;boost/algorithm/string/trim.hpp&gt;">
9 <link rel="prev" href="trim_if.html" title="Function template trim_if">
10 <link rel="next" href="trim_all_copy_if.html" title="Function template trim_all_copy_if">
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="trim_if.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.trim_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="trim_all_copy_if.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="refentry">
26 <a name="boost.algorithm.trim"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Function template trim</span></h2>
29 <p>boost::algorithm::trim &#8212; Trim. </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="../../string_algo/reference.html#header.boost.algorithm.string.trim_hpp" title="Header &lt;boost/algorithm/string/trim.hpp&gt;">boost/algorithm/string/trim.hpp</a>&gt;
33
34 </span>
35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SequenceT<span class="special">&gt;</span> 
36   <span class="keyword">void</span> <span class="identifier">trim</span><span class="special">(</span><span class="identifier">SequenceT</span> <span class="special">&amp;</span> Input<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">&amp;</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>
37 <div class="refsect1">
38 <a name="idp439515312"></a><h2>Description</h2>
39 <p>Remove all leading and trailing spaces from the input. The input sequence is modified in-place.</p>
40 <p>
41 </p>
42 <div class="variablelist"><table border="0" class="variablelist compact">
43 <colgroup>
44 <col align="left" valign="top">
45 <col>
46 </colgroup>
47 <tbody><tr>
48 <td><p><span class="term">Parameters:</span></p></td>
49 <td><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"><code class="computeroutput">Input</code></span></p></td>
57 <td><p>An input sequence </p></td>
58 </tr>
59 <tr>
60 <td><p><span class="term"><code class="computeroutput">Loc</code></span></p></td>
61 <td><p>A locale used for 'space' classification </p></td>
62 </tr>
63 </tbody>
64 </table></div></td>
65 </tr></tbody>
66 </table></div>
67 </div>
68 </div>
69 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
70 <td align="left"></td>
71 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
72                 Software License, Version 1.0. (See accompanying file
73                 <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>)
74             </p>
75 </div></td>
76 </tr></table>
77 <hr>
78 <div class="spirit-nav">
79 <a accesskey="p" href="trim_if.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.trim_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="trim_all_copy_if.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
80 </div>
81 </body>
82 </html>