ostrstream Class

 

The latest version of this topic can be found at ostrstream Class.

Describes an object that controls insertion of elements and encoded objects into a stream buffer of class strstreambuf.

Syntax

class ostrstream : public ostream

Remarks

The object stores an object of class strstreambuf.

Note

This class is deprecated. Consider using ostringstream or wostringstream instead.

Constructors

ostrstream

Constructs an object of type ostrstream.

Member Functions

freeze	Causes a stream buffer to be unavailable through stream buffer operations.
pcount	Returns a count of the number of elements written to the controlled sequence.
rdbuf	Returns a pointer to the stream's associated strstreambuf object.
str	Calls freeze, and then returns a pointer to the beginning of the controlled sequence.

Requirements

Header: <strstream>

Namespace: std

ostrstream::freeze

Causes a stream buffer to be unavailable through stream buffer operations.

void freeze(bool _Freezeit = true);

Parameters

_Freezeit
A bool indicating whether you want the stream to be frozen.

Remarks

The member function calls rdbuf -> freeze(_ Freezeit).

Example

See strstream::freeze for an example that uses freeze.

ostrstream::ostrstream

Constructs an object of type ostrstream.

ostrstream();

ostrstream(char* ptr,
    streamsize count,
    ios_base::openmode _Mode = ios_base::out);

Parameters

ptr
The buffer.

count
The size of the buffer in bytes.

_Mode
The input and output mode of the buffer. See ios_base::openmode for more information.

Remarks

Both constructors initialize the base class by calling ostream( sb), where sb is the stored object of class strstreambuf. The first constructor also initializes sb by calling strstreambuf. The second constructor initializes the base class one of two ways:

• If _Mode & ios_base::app== 0, then ptr must designate the first element of an array of count elements, and the constructor calls strstreambuf( ptr, count, ptr).

• Otherwise, ptr must designate the first element of an array of count elements that contains a C string whose first element is designated by ptr, and the constructor calls strstreambuf( ptr, count, ptr + strlen( ptr) ).

ostrstream::pcount

Returns a count of the number of elements written to the controlled sequence.

streamsize pcount() const;

Return Value

The number of elements written to the controlled sequence.

Remarks

The member function returns rdbuf -> pcount.

Example

See strstream::pcount for a sample that uses pcount.

ostrstream::rdbuf

Returns a pointer to the stream's associated strstreambuf object.

strstreambuf *rdbuf
() const

Return Value

A pointer to the stream's associated strstreambuf object.

Remarks

The member function returns the address of the stored stream buffer of type pointer to strstreambuf.

Example

See strstreambuf::pcount for a sample that uses rdbuf.

ostrstream::str

Calls freeze, and then returns a pointer to the beginning of the controlled sequence.

char *str();

Return Value

A pointer to the beginning of the controlled sequence.

Remarks

The member function returns rdbuf -> str.

Example

See strstream::str for a sample that uses str.

See Also

ostream
Thread Safety in the C++ Standard Library
iostream Programming
iostreams Conventions