Input/output library
Buffers
Streams
Abstractions
File I/O
String I/O
Array I/O
Synchronized Output
Types
Error category interface
std::basic_ostream
Global objects
Member functions
Formatted output
Unformatted output
Positioning
Miscellaneous
Member classes
Non-member functions
The class template basic_ostream
provides support for high level output operations on character streams. The supported operations include formatted output (e.g. integer values) and unformatted output (e.g. raw characters and character arrays). This functionality is implemented in terms of the interface provided by the basic_streambuf
class, accessed through the basic_ios
base class. In typical implementations, basic_ostream
has no non-inherited data members.
std-basic ostream-inheritance.svg
Several typedefs for common character types are provided:
Type
Definition
std::ostream
std::basic_ostream<char>
std::wostream
std::basic_ostream<wchar_t>
[edit] Global objects
Six global basic_ostream
objects are provided by the standard library:
writes to the standard C output stream
stdout (global object)[edit]
writes to the standard C error stream
stderr , unbuffered
(global object)[edit]
writes to the standard C error stream
stderr (global object)[edit]
[edit] Member types
Member type
Definition
traits_type
Traits
; the program is ill-formed if
Traits::char_type
is not
CharT
.
[edit]
int_type
Traits::int_type
[edit]
pos_type
Traits::pos_type
[edit]
off_type
Traits::off_type
[edit]
[edit] Member functions
constructs the object
(public member function) [edit]
destructs the object
(virtual public member function) [edit]
move-assigns from another
basic_ostream
(protected member function) [edit]
Formatted output
inserts formatted data
(public member function) [edit]
Unformatted output
inserts a character
(public member function) [edit]
inserts blocks of characters
(public member function) [edit]
Positioning
returns the output position indicator
(public member function) [edit]
sets the output position indicator
(public member function) [edit]
Miscellaneous
synchronizes with the underlying storage device
(public member function) [edit]
swaps stream objects, except for the associated buffer
(protected member function) [edit]
[edit] Member classes
implements basic logic for preparation of the stream for output operations
(public member class) [edit]
[edit] Non-member functions
inserts character data or insert into rvalue stream
(function template) [edit]
outputs
formatted representation of the arguments
(function template) [edit]
outputs
formatted representation of the arguments with appended
'\n' (function template) [edit]
performs Unicode aware output using
type-erased argument representation
(function) [edit]
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
checks if no error has occurred i.e. I/O operations are available
(public member function of std::basic_ios<CharT,Traits>
) [edit]
checks if end-of-file has been reached
(public member function of std::basic_ios<CharT,Traits>
) [edit]
checks if an error has occurred
(public member function of std::basic_ios<CharT,Traits>
) [edit]
checks if a non-recoverable error has occurred
(public member function of std::basic_ios<CharT,Traits>
) [edit]
checks if an error has occurred (synonym of
fail() )
(public member function of std::basic_ios<CharT,Traits>
) [edit]
checks if no error has occurred (synonym of
!
fail() )
(public member function of std::basic_ios<CharT,Traits>
) [edit]
returns state flags
(public member function of std::basic_ios<CharT,Traits>
) [edit]
sets state flags
(public member function of std::basic_ios<CharT,Traits>
) [edit]
modifies state flags
(public member function of std::basic_ios<CharT,Traits>
) [edit]
Formatting
copies formatting information
(public member function of std::basic_ios<CharT,Traits>
) [edit]
manages the fill character
(public member function of std::basic_ios<CharT,Traits>
) [edit]
Miscellaneous
manages exception mask
(public member function of std::basic_ios<CharT,Traits>
) [edit]
sets the locale
(public member function of std::basic_ios<CharT,Traits>
) [edit]
manages associated stream buffer
(public member function of std::basic_ios<CharT,Traits>
) [edit]
manages tied stream
(public member function of std::basic_ios<CharT,Traits>
) [edit]
narrows characters
(public member function of std::basic_ios<CharT,Traits>
) [edit]
widens characters
(public member function of std::basic_ios<CharT,Traits>
) [edit]
Member functions
Formatting
manages format flags
(public member function of std::ios_base
) [edit]
sets specific format flag
(public member function of std::ios_base
) [edit]
clears specific format flag
(public member function of std::ios_base
) [edit]
manages decimal precision of floating point operations
(public member function of std::ios_base
) [edit]
manages field width
(public member function of std::ios_base
) [edit]
Locales
sets locale
(public member function of std::ios_base
) [edit]
returns current locale
(public member function of std::ios_base
) [edit]
Internal extensible array
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
) [edit]
resizes the private storage if necessary and access to the
long element at the given index
(public member function of std::ios_base
) [edit]
resizes the private storage if necessary and access to the
void* element at the given index
(public member function of std::ios_base
) [edit]
Miscellaneous
registers event callback function
(public member function of std::ios_base
) [edit]
sets whether C++ and C I/O libraries are interoperable
(public static member function of std::ios_base
) [edit]
Member classes
stream exception
(public member class of std::ios_base
) [edit]
initializes standard stream objects
(public member class of std::ios_base
) [edit]
Member types and constants
Type
Explanation
stream open mode type
The following constants are also defined:
app
seek to the end of stream before each write
[edit]
trunc
discard the contents of the stream when opening
[edit]
ate
seek to the end of stream immediately after open
[edit]
(typedef) [edit]
formatting flags type
The following constants are also defined:
fixed
generate floating point types using fixed notation, or hex notation if combined with
scientific: see
std::fixed [edit]
showbase
generate a prefix indicating the numeric base for integer output, require the currency indicator in monetary I/O: see
std::showbase [edit]
(typedef) [edit]
state of the stream type
The following constants are also defined:
failbit
input/output operation failed (formatting or extraction error)
[edit]
eofbit
associated input sequence has reached end-of-file
[edit]
(typedef) [edit]
seeking direction type
The following constants are also defined:
cur
the current position of stream position indicator
[edit]
(typedef) [edit]
specifies event type
(enum) [edit]
callback function type
(typedef) [edit]