# std::basic_ostringstream

From cppreference.com
< cpp‎ | io

Defined in header `<sstream>` |  |
template< class CharT, class Traits = std::char_traits<CharT> > class basic_ostringstream; |  | (until C++11)
template< class CharT, class Traits = std::char_traits<CharT>, class Allocator = std::allocator<CharT> > class basic_ostringstream; |  | (since C++11)

The class template `std::basic_ostringstream` implements output operations on memory (std::basic_string) based streams. It essentially wraps a raw string device implementation (std::basic_stringbuf) into a higher-level interface (std::basic_ostream). The complete interface to unique `std::basic_stringbuf` members is provided.

Inheritance diagram

Two specializations for common character types are also defined:

Defined in header `<sstream>`
Type | Definition
`ostringstream` | basic_ostringstream<char>
`wostringstream` | basic_ostringstream<wchar_t>

### Member types

Member type | Definition
`char_type` | CharT
`traits_type` | Traits
`int_type` | Traits::int_type
`pos_type` | Traits::pos_type
`off_type` | Traits::off_type
`allocator_type` | Allocator (since C++11)

### Member functions

(constructor) | constructs the string stream (public member function)
operator= (C++11) | moves the string stream (public member function)
swap (C++11) | swaps two string streams (public member function)
rdbuf | returns the underlying raw string device object (public member function)

##### String operations

str | gets or sets the contents of underlying string device object (public member function)

### Non-member functions

std::swap(std::basic_ostringstream) (C++11) | specializes the std::swap algorithm (function template)

## Inherited from std::basic_ostream

### Member functions

##### Formatted input

operator<< | inserts formatted data (public member function of `std::basic_ostream`)

##### Unformatted input

put | inserts a character (public member function of `std::basic_ostream`)
write | inserts blocks of characters (public member function of `std::basic_ostream`)

##### Positioning

tellp | returns the output position indicator (public member function of `std::basic_ostream`)
seekp | sets the output position indicator (public member function of `std::basic_ostream`)

##### Miscellaneous

flush | synchronizes with the underlying storage device (public member function of `std::basic_ostream`)

### Member classes

sentry | implements basic logic for preparation of the stream for output operations (public member class of `std::basic_ostream`)

## Inherited from std::basic_ios

### Member types

Member type | Definition
`char_type` | CharT
`traits_type` | Traits
`int_type` | Traits::int_type
`pos_type` | Traits::pos_type
`off_type` | Traits::off_type

### Member functions

##### State functions

good | checks if no error has occurred i.e. I/O operations are available (public member function of `std::basic_ios`)
eof | checks if end-of-file has been reached (public member function of `std::basic_ios`)
fail | checks if an error has occurred (public member function of `std::basic_ios`)
bad | checks if a non-recoverable error has occurred (public member function of `std::basic_ios`)
operator! | checks if an error has occurred (synonym of fail()) (public member function of `std::basic_ios`)
operator void*operator bool (until C++11)(since C++11) | checks if no error has occurred (synonym of !fail()) (public member function of `std::basic_ios`)
rdstate | returns state flags (public member function of `std::basic_ios`)
setstate | sets state flags (public member function of `std::basic_ios`)
clear | clears error and eof flags (public member function of `std::basic_ios`)

##### Formatting

copyfmt | copies formatting information (public member function of `std::basic_ios`)
fill | manages the fill character (public member function of `std::basic_ios`)

##### Miscellaneous

exceptions | manages exception mask (public member function of `std::basic_ios`)
imbue | sets the locale (public member function of `std::basic_ios`)
rdbuf | manages associated stream buffer (public member function of `std::basic_ios`)
tie | manages tied stream (public member function of `std::basic_ios`)
narrow | narrows characters (public member function of `std::basic_ios`)
widen | widens characters (public member function of `std::basic_ios`)

## Inherited from std::ios_base

### Member functions

##### Formatting

flags | manages format flags (public member function of `std::ios_base`)
setf | sets specific format flag (public member function of `std::ios_base`)
unsetf | clears specific format flag (public member function of `std::ios_base`)
precision | manages decimal precision of floating point operations (public member function of `std::ios_base`)
width | manages field width (public member function of `std::ios_base`)

##### Locales

imbue | sets locale (public member function of `std::ios_base`)
getloc | returns current locale (public member function of `std::ios_base`)

##### Internal extensible array

xalloc [static] | returns a program-wide unique integer that is safe to use as index to pword() and iword() (public static member function of `std::ios_base`)
iword | resizes the private storage if necessary and access to the long element at the given index (public member function of `std::ios_base`)
pword | resizes the private storage if necessary and access to the void* element at the given index (public member function of `std::ios_base`)

##### Miscellaneous

register_callback | registers event callback function (public member function of `std::ios_base`)
sync_with_stdio [static] | sets whether C++ and C IO libraries are interoperable (public static member function of `std::ios_base`)

##### Member classes

failure | stream exception (public member class of `std::ios_base`)
Init | initializes standard stream objects (public member class of `std::ios_base`)

### Member types and constants

Type | Explanation

openmode

stream open mode type

The following constants are also defined:

Constant | Explanation
`app` | seek to the end of stream before each write
`binary` | open in binary mode
`in` | open for reading
`out` | open for writing
`trunc` | discard the contents of the stream when opening
`ate` | seek to the end of stream immediately after open

(typedef)

fmtflags

formatting flags type

The following constants are also defined:

Constant | Explanation
`dec` | use decimal base for integer I/O: see std::dec
`oct` | use octal base for integer I/O: see std::oct
`hex` | use hexadecimal base for integer I/O: see std::hex
`basefield` | dec|oct|hex|0. Useful for masking operations
`left` | left adjustment (adds fill characters to the right): see std::left
`right` | right adjustment (adds fill characters to the left): see std::right
`internal` | internal adjustment (adds fill characters to the internal designated point): see std::internal
`adjustfield` | left|right|internal. Useful for masking operations
`scientific` | generate floating point types using scientific notation, or hex notation if combined with fixed: see std::scientific
`fixed` | generate floating point types using fixed notation, or hex notation if combined with scientific: see std::fixed
`floatfield` | scientific|fixed|(scientific|fixed)|0. Useful for masking operations
`boolalpha` | insert and extract bool type in alphanumeric format: see std::boolalpha
`showbase` | generate a prefix indicating the numeric base for integer output, require the currency indicator in monetary I/O: see std::showbase
`showpoint` | generate a decimal-point character unconditionally for floating-point number output: see std::showpoint
`showpos` | generate a + character for non-negative numeric output: see std::showpos
`skipws` | skip leading whitespace before certain input operations: see std::skipws
`unitbuf` | flush the output after each output operation: see std::unitbuf
`uppercase` | replace certain lowercase letters with their uppercase equivalents in certain output output operations: see std::uppercase

(typedef)

iostate

state of the stream type

The following constants are also defined:

Constant | Explanation
`goodbit` | no error
`badbit` | irrecoverable stream error
`failbit` | input/output operation failed (formatting or extraction error)
`eofbit` | associated input sequence has reached end-of-file

(typedef)

seekdir

seeking direction type

The following constants are also defined:

Constant | Explanation
`beg` | the beginning of a stream
`end` | the ending of a stream
`cur` | the current position of stream position indicator

(typedef)

event | specifies event type (enum)
event_callback | callback function type (typedef)

Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/io/basic_ostringstream&oldid=71794"