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>Class template basic_obufferstream</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="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_hpp" title="Header <boost/interprocess/streams/bufferstream.hpp>"> 10<link rel="prev" href="basic_ibufferstream.html" title="Class template basic_ibufferstream"> 11<link rel="next" href="basic_ivectorstream.html" title="Class template basic_ivectorstream"> 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="basic_ibufferstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_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="basic_ivectorstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.interprocess.basic_obufferstream"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template basic_obufferstream</span></h2> 30<p>boost::interprocess::basic_obufferstream</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="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_hpp" title="Header <boost/interprocess/streams/bufferstream.hpp>">boost/interprocess/streams/bufferstream.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> CharTraits<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="basic_obufferstream.html" title="Class template basic_obufferstream">basic_obufferstream</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// types</span> 39 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">char_type</span> <a name="boost.interprocess.basic_obufferstream.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">int_type</span> <a name="boost.interprocess.basic_obufferstream.int_type"></a><span class="identifier">int_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">pos_type</span> <a name="boost.interprocess.basic_obufferstream.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span> 42 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">off_type</span> <a name="boost.interprocess.basic_obufferstream.off_type"></a><span class="identifier">off_type</span><span class="special">;</span> 43 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">traits_type</span> <a name="boost.interprocess.basic_obufferstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> 44 45 <span class="comment">// <a class="link" href="basic_obufferstream.html#boost.interprocess.basic_obufferstreamconstruct-copy-destruct">construct/copy/destruct</a></span> 46 <a class="link" href="basic_obufferstream.html#idm45304010583520-bb"><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> 47 <a class="link" href="basic_obufferstream.html#idm45304010581824-bb"><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> 48 <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> 49 <a class="link" href="basic_obufferstream.html#idm45304010578720-bb"><span class="special">~</span><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 50 51 <span class="comment">// <a class="link" href="basic_obufferstream.html#idm45304010590400-bb">public member functions</a></span> 52 <a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_obufferstream.html#idm45304010589840-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 53 <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_obufferstream.html#idm45304010587984-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 54 <span class="keyword">void</span> <a class="link" href="basic_obufferstream.html#idm45304010586384-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> 55<span class="special">}</span><span class="special">;</span></pre></div> 56<div class="refsect1"> 57<a name="id-1.3.19.17.3.55.7.4"></a><h2>Description</h2> 58<p>A basic_ostream class that uses a fixed size character buffer as its formatting buffer. </p> 59<div class="refsect2"> 60<a name="id-1.3.19.17.3.55.7.4.3"></a><h3> 61<a name="boost.interprocess.basic_obufferstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_obufferstream</code> 62 public 63 construct/copy/destruct</h3> 64<div class="orderedlist"><ol class="orderedlist" type="1"> 65<li class="listitem"> 66<pre class="literallayout"><a name="idm45304010583520-bb"></a><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> 67<p>Constructor. Does not throw. </p> 68</li> 69<li class="listitem"> 70<pre class="literallayout"><a name="idm45304010581824-bb"></a><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> 71 <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> 72<p>Constructor. Assigns formatting buffer. Does not throw. </p> 73</li> 74<li class="listitem"><pre class="literallayout"><a name="idm45304010578720-bb"></a><span class="special">~</span><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 75</ol></div> 76</div> 77<div class="refsect2"> 78<a name="id-1.3.19.17.3.55.7.4.4"></a><h3> 79<a name="idm45304010590400-bb"></a><code class="computeroutput">basic_obufferstream</code> public member functions</h3> 80<div class="orderedlist"><ol class="orderedlist" type="1"> 81<li class="listitem"> 82<pre class="literallayout"><a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idm45304010589840-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 83<p>Returns the address of the stored stream buffer. </p> 84</li> 85<li class="listitem"> 86<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idm45304010587984-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 87<p>Returns the pointer and size of the internal buffer. Does not throw. </p> 88</li> 89<li class="listitem"> 90<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304010586384-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> 91<p>Sets the underlying buffer to a new value. Resets stream position. Does not throw. </p> 92</li> 93</ol></div> 94</div> 95</div> 96</div> 97<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 98<td align="left"></td> 99<td align="right"><div class="copyright-footer">Copyright © 2005-2015 Ion Gaztanaga<p> 100 Distributed under the Boost Software License, Version 1.0. (See accompanying 101 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>) 102 </p> 103</div></td> 104</tr></table> 105<hr> 106<div class="spirit-nav"> 107<a accesskey="p" href="basic_ibufferstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.bufferstream_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="basic_ivectorstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 108</div> 109</body> 110</html> 111