1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_static_string::copy</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="subview.html" title="basic_static_string::subview"> 10<link rel="next" href="resize.html" title="basic_static_string::resize"> 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="subview.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="resize.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.copy"></a><a class="link" href="copy.html" title="basic_static_string::copy">basic_static_string::copy</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="idm45714125779376"></a> 31 </p> 32<p> 33 Copy a substring to another string. 34 </p> 35<h6> 36<a name="static_string.ref.boost__static_strings__basic_static_string.copy.h0"></a> 37 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.copy.synopsis"></a></span><a class="link" href="copy.html#static_string.ref.boost__static_strings__basic_static_string.copy.synopsis">Synopsis</a> 38 </h6> 39<pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">size_type</span> 40<span class="identifier">copy</span><span class="special">(</span> 41 <span class="identifier">pointer</span> <span class="identifier">dest</span><span class="special">,</span> 42 <span class="identifier">size_type</span> <span class="identifier">count</span><span class="special">,</span> 43 <span class="identifier">size_type</span> <span class="identifier">pos</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 44</pre> 45<h6> 46<a name="static_string.ref.boost__static_strings__basic_static_string.copy.h1"></a> 47 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.copy.description"></a></span><a class="link" href="copy.html#static_string.ref.boost__static_strings__basic_static_string.copy.description">Description</a> 48 </h6> 49<p> 50 Copies 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> 51 - pos) characters starting at index <code class="computeroutput"><span class="identifier">pos</span></code> 52 to the string pointed to by <code class="computeroutput"><span class="identifier">dest</span></code>. 53 </p> 54<h6> 55<a name="static_string.ref.boost__static_strings__basic_static_string.copy.h2"></a> 56 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.copy.remarks"></a></span><a class="link" href="copy.html#static_string.ref.boost__static_strings__basic_static_string.copy.remarks">Remarks</a> 57 </h6> 58<p> 59 The resulting string is not null terminated. 60 </p> 61<h6> 62<a name="static_string.ref.boost__static_strings__basic_static_string.copy.h3"></a> 63 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.copy.return_value"></a></span><a class="link" href="copy.html#static_string.ref.boost__static_strings__basic_static_string.copy.return_value">Return 64 Value</a> 65 </h6> 66<p> 67 The number of characters copied. 68 </p> 69<h6> 70<a name="static_string.ref.boost__static_strings__basic_static_string.copy.h4"></a> 71 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.copy.parameters"></a></span><a class="link" href="copy.html#static_string.ref.boost__static_strings__basic_static_string.copy.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">count</span></code> 95 </p> 96 </td> 97<td> 98 <p> 99 The number of characters to copy. 100 </p> 101 </td> 102</tr> 103<tr> 104<td> 105 <p> 106 <code class="computeroutput"><span class="identifier">dest</span></code> 107 </p> 108 </td> 109<td> 110 <p> 111 The string to copy to. 112 </p> 113 </td> 114</tr> 115<tr> 116<td> 117 <p> 118 <code class="computeroutput"><span class="identifier">pos</span></code> 119 </p> 120 </td> 121<td> 122 <p> 123 The index to begin copying from. The default argument for this 124 parameter is <code class="computeroutput"><span class="number">0</span></code>. 125 </p> 126 </td> 127</tr> 128</tbody> 129</table></div> 130<h6> 131<a name="static_string.ref.boost__static_strings__basic_static_string.copy.h5"></a> 132 <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.copy.exceptions"></a></span><a class="link" href="copy.html#static_string.ref.boost__static_strings__basic_static_string.copy.exceptions">Exceptions</a> 133 </h6> 134<div class="informaltable"><table class="table"> 135<colgroup> 136<col> 137<col> 138</colgroup> 139<thead><tr> 140<th> 141 <p> 142 Type 143 </p> 144 </th> 145<th> 146 <p> 147 Thrown On 148 </p> 149 </th> 150</tr></thead> 151<tbody><tr> 152<td> 153 <p> 154 <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">out_of_range</span></code> 155 </p> 156 </td> 157<td> 158 <p> 159 pos > <a class="link" href="max_size.html" title="basic_static_string::max_size"><code class="computeroutput"><span class="identifier">max_size</span><span class="special">()</span></code></a> 160 </p> 161 </td> 162</tr></tbody> 163</table></div> 164</div> 165<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 166<td align="left"></td> 167<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie 168 Falco<p> 169 Distributed under the Boost Software License, Version 1.0. (See accompanying 170 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>) 171 </p> 172</div></td> 173</tr></table> 174<hr> 175<div class="spirit-nav"> 176<a accesskey="p" href="subview.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="resize.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 177</div> 178</body> 179</html> 180
