1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_static_string::substr</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="Boost.StaticString"> 8<link rel="up" href="../boost__static_strings__basic_static_string.html" title="basic_static_string"> 9<link rel="prev" href="compare/overload9.html" title="basic_static_string::compare (9 of 9 overloads)"> 10<link rel="next" href="subview.html" title="basic_static_string::subview"> 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="compare/overload9.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__static_strings__basic_static_string.html"><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="subview.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="static_string.ref.boost__static_strings__basic_static_string.substr"></a><a class="link" href="substr.html" title="basic_static_string::substr">basic_static_string::substr</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="idm45714125906752"></a> 31 </p> 32<p> 33 Return a substring. 34 </p> 35<h6> 36<a name="static_string.ref.boost__static_strings__basic_static_string.substr.h0"></a> 37 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.substr.synopsis"></a></span><a class="link" href="substr.html#static_string.ref.boost__static_strings__basic_static_string.substr.synopsis">Synopsis</a> 38 </h6> 39<pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">basic_static_string</span> 40<span class="identifier">substr</span><span class="special">(</span> 41 <span class="identifier">size_type</span> <span class="identifier">pos</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> 42 <span class="identifier">size_type</span> <span class="identifier">count</span> <span class="special">=</span> <a class="link" href="npos.html" title="basic_static_string::npos">npos</a><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 43</pre> 44<h6> 45<a name="static_string.ref.boost__static_strings__basic_static_string.substr.h1"></a> 46 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.substr.description"></a></span><a class="link" href="substr.html#static_string.ref.boost__static_strings__basic_static_string.substr.description">Description</a> 47 </h6> 48<p> 49 Returns a substring of the string. 50 </p> 51<h6> 52<a name="static_string.ref.boost__static_strings__basic_static_string.substr.h2"></a> 53 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.substr.exception_safety"></a></span><a class="link" href="substr.html#static_string.ref.boost__static_strings__basic_static_string.substr.exception_safety">Exception 54 Safety</a> 55 </h6> 56<p> 57 Strong guarantee. 58 </p> 59<h6> 60<a name="static_string.ref.boost__static_strings__basic_static_string.substr.h3"></a> 61 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.substr.return_value"></a></span><a class="link" href="substr.html#static_string.ref.boost__static_strings__basic_static_string.substr.return_value">Return 62 Value</a> 63 </h6> 64<p> 65 A string object containing the characters {<a class="link" href="data/overload1.html" title="basic_static_string::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code></a> 66 + pos, std::min(count, <a class="link" href="size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a> 67 - pos)). 68 </p> 69<h6> 70<a name="static_string.ref.boost__static_strings__basic_static_string.substr.h4"></a> 71 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.substr.parameters"></a></span><a class="link" href="substr.html#static_string.ref.boost__static_strings__basic_static_string.substr.parameters">Parameters</a> 72 </h6> 73<div class="informaltable"><table class="table"> 74<colgroup> 75<col> 76<col> 77</colgroup> 78<thead><tr> 79<th> 80 <p> 81 Name 82 </p> 83 </th> 84<th> 85 <p> 86 Description 87 </p> 88 </th> 89</tr></thead> 90<tbody> 91<tr> 92<td> 93 <p> 94 <code class="computeroutput"><span class="identifier">pos</span></code> 95 </p> 96 </td> 97<td> 98 <p> 99 The index to being the substring at. The default arugment for 100 this parameter is <code class="computeroutput"><span class="number">0</span></code>. 101 </p> 102 </td> 103</tr> 104<tr> 105<td> 106 <p> 107 <code class="computeroutput"><span class="identifier">count</span></code> 108 </p> 109 </td> 110<td> 111 <p> 112 The length of the substring. The default arugment for this parameter 113 is <a class="link" href="npos.html" title="basic_static_string::npos"><code class="computeroutput"><span class="identifier">npos</span></code></a>. 114 </p> 115 </td> 116</tr> 117</tbody> 118</table></div> 119<h6> 120<a name="static_string.ref.boost__static_strings__basic_static_string.substr.h5"></a> 121 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.substr.exceptions"></a></span><a class="link" href="substr.html#static_string.ref.boost__static_strings__basic_static_string.substr.exceptions">Exceptions</a> 122 </h6> 123<div class="informaltable"><table class="table"> 124<colgroup> 125<col> 126<col> 127</colgroup> 128<thead><tr> 129<th> 130 <p> 131 Type 132 </p> 133 </th> 134<th> 135 <p> 136 Thrown On 137 </p> 138 </th> 139</tr></thead> 140<tbody><tr> 141<td> 142 <p> 143 <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">out_of_range</span></code> 144 </p> 145 </td> 146<td> 147 <p> 148 pos > <a class="link" href="size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a> 149 </p> 150 </td> 151</tr></tbody> 152</table></div> 153</div> 154<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 155<td align="left"></td> 156<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie 157 Falco<p> 158 Distributed under the Boost Software License, Version 1.0. (See accompanying 159 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>) 160 </p> 161</div></td> 162</tr></table> 163<hr> 164<div class="spirit-nav"> 165<a accesskey="p" href="compare/overload9.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__static_strings__basic_static_string.html"><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="subview.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 166</div> 167</body> 168</html> 169
