1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>basic_streambuf::prepare</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="../../../boost_asio.html" title="Boost.Asio"> 8<link rel="up" href="../basic_streambuf.html" title="basic_streambuf"> 9<link rel="prev" href="overflow.html" title="basic_streambuf::overflow"> 10<link rel="next" href="reserve.html" title="basic_streambuf::reserve"> 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="overflow.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_streambuf.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reserve.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="boost_asio.reference.basic_streambuf.prepare"></a><a class="link" href="prepare.html" title="basic_streambuf::prepare">basic_streambuf::prepare</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.basic_streambuf.prepare"></a> 31Get a 32 list of buffers that represents the output sequence, with the given size. 33 </p> 34<pre class="programlisting">mutable_buffers_type prepare( 35 std::size_t n); 36</pre> 37<p> 38 Ensures that the output sequence can accommodate <code class="computeroutput">n</code> characters, 39 reallocating character array objects as necessary. 40 </p> 41<h6> 42<a name="boost_asio.reference.basic_streambuf.prepare.h0"></a> 43 <span class="phrase"><a name="boost_asio.reference.basic_streambuf.prepare.return_value"></a></span><a class="link" href="prepare.html#boost_asio.reference.basic_streambuf.prepare.return_value">Return 44 Value</a> 45 </h6> 46<p> 47 An object of type <code class="computeroutput">mutable_buffers_type</code> that satisfies MutableBufferSequence 48 requirements, representing character array objects at the start of the 49 output sequence such that the sum of the buffer sizes is <code class="computeroutput">n</code>. 50 </p> 51<h6> 52<a name="boost_asio.reference.basic_streambuf.prepare.h1"></a> 53 <span class="phrase"><a name="boost_asio.reference.basic_streambuf.prepare.exceptions"></a></span><a class="link" href="prepare.html#boost_asio.reference.basic_streambuf.prepare.exceptions">Exceptions</a> 54 </h6> 55<div class="variablelist"> 56<p class="title"><b></b></p> 57<dl class="variablelist"> 58<dt><span class="term">std::length_error</span></dt> 59<dd><p> 60 If <code class="computeroutput">size() + n > max_size()</code>. 61 </p></dd> 62</dl> 63</div> 64<h6> 65<a name="boost_asio.reference.basic_streambuf.prepare.h2"></a> 66 <span class="phrase"><a name="boost_asio.reference.basic_streambuf.prepare.remarks"></a></span><a class="link" href="prepare.html#boost_asio.reference.basic_streambuf.prepare.remarks">Remarks</a> 67 </h6> 68<p> 69 The returned object is invalidated by any <code class="computeroutput">basic_streambuf</code> 70 member function that modifies the input sequence or output sequence. 71 </p> 72</div> 73<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 74<td align="left"></td> 75<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 76 Kohlhoff<p> 77 Distributed under the Boost Software License, Version 1.0. (See accompanying 78 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>) 79 </p> 80</div></td> 81</tr></table> 82<hr> 83<div class="spirit-nav"> 84<a accesskey="p" href="overflow.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_streambuf.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="reserve.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 85</div> 86</body> 87</html> 88
