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 starts_with</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.predicate_hpp" title="Header <boost/algorithm/string/predicate.hpp>"> 10<link rel="prev" href="join_if_1_3_3_9_14_3_1_2.html" title="Function template join_if"> 11<link rel="next" href="istarts_with.html" title="Function template istarts_with"> 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="join_if_1_3_3_9_14_3_1_2.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.predicate_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="istarts_with.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.algorithm.starts_with"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Function starts_with</span></h2> 30<p>boost::algorithm::starts_with — 'Starts with' predicate </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.predicate_hpp" title="Header <boost/algorithm/string/predicate.hpp>">boost/algorithm/string/predicate.hpp</a>> 34 35</span> 36<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Range1T<span class="special">,</span> <span class="keyword">typename</span> Range2T<span class="special">,</span> <span class="keyword">typename</span> PredicateT<span class="special">></span> 37 <span class="keyword">bool</span> <span class="identifier">starts_with</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Range1T</span> <span class="special">&</span> Input<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Range2T</span> <span class="special">&</span> Test<span class="special">,</span> 38 <span class="identifier">PredicateT</span> Comp<span class="special">)</span><span class="special">;</span> 39<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Range1T<span class="special">,</span> <span class="keyword">typename</span> Range2T<span class="special">></span> 40 <span class="keyword">bool</span> <span class="identifier">starts_with</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Range1T</span> <span class="special">&</span> Input<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Range2T</span> <span class="special">&</span> Test<span class="special">)</span><span class="special">;</span></pre></div> 41<div class="refsect1"> 42<a name="id-1.3.3.9.16.5.4"></a><h2>Description</h2> 43<p>This predicate holds when the test string is a prefix of the Input. In other words, if the input starts with the test. When the optional predicate is specified, it is used for character-wise comparison.</p> 44<p> 45 46</p> 47<div class="note"><table border="0" summary="Note"> 48<tr> 49<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> 50<th align="left">Note</th> 51</tr> 52<tr><td align="left" valign="top"><p>This function provides the strong exception-safety guarantee </p></td></tr> 53</table></div> 54<p> 55</p> 56<div class="variablelist"><table border="0" class="variablelist compact"> 57<colgroup> 58<col align="left" valign="top"> 59<col> 60</colgroup> 61<tbody> 62<tr> 63<td><p><span class="term">Parameters:</span></p></td> 64<td><div class="variablelist"><table border="0" class="variablelist compact"> 65<colgroup> 66<col align="left" valign="top"> 67<col> 68</colgroup> 69<tbody> 70<tr> 71<td><p><span class="term"><code class="computeroutput">Comp</code></span></p></td> 72<td><p>An element comparison predicate </p></td> 73</tr> 74<tr> 75<td><p><span class="term"><code class="computeroutput">Input</code></span></p></td> 76<td><p>An input sequence </p></td> 77</tr> 78<tr> 79<td><p><span class="term"><code class="computeroutput">Test</code></span></p></td> 80<td><p>A test sequence </p></td> 81</tr> 82</tbody> 83</table></div></td> 84</tr> 85<tr> 86<td><p><span class="term">Returns:</span></p></td> 87<td><p>The result of the test</p></td> 88</tr> 89</tbody> 90</table></div> 91</div> 92</div> 93<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 94<td align="left"></td> 95<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost 96 Software License, Version 1.0. (See accompanying file 97 <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>) 98 </p> 99</div></td> 100</tr></table> 101<hr> 102<div class="spirit-nav"> 103<a accesskey="p" href="join_if_1_3_3_9_14_3_1_2.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.predicate_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="istarts_with.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 104</div> 105</body> 106</html> 107
