std::basic_ostream<CharT,Traits>::seekp

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Technical Specifications

 

Input/output library

I/O manipulators

C-style I/O

Buffers

basic_streambuf

basic_filebuf

basic_stringbuf

strstreambuf (deprecated in C++98)

basic_syncbuf (C++20)

Streams

Abstractions

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

File I/O

basic_ifstream

basic_ofstream

basic_fstream

String I/O

basic_istringstream

basic_ostringstream

basic_stringstream

Array I/O

istrstream (deprecated in C++98)

ostrstream (deprecated in C++98)

strstream (deprecated in C++98)

Synchronized Output

basic_osyncstream (C++20)

Types

streamoff

streamsize

fpos

Error category interface

iostream_category (C++11)

io_errc (C++11)

 

std::basic_ostream

Global objects
coutwcout	cerrwcerr	clogwclog
Member functions
basic_ostream::basic_ostream
basic_ostream::~basic_ostream
basic_ostream::operator= (C++11)
Formatted output
basic_ostream::operator<<
Unformatted output
basic_ostream::put
basic_ostream::write
Positioning
basic_ostream::tellp
basic_ostream::seekp
Miscellaneous
basic_ostream::flush
basic_ostream::swap (C++11)
Member classes
basic_ostream::sentry
Non-member functions
operator<<(std::basic_ostream)

 

basic_ostream& seekp( pos_type pos );	(1)
basic_ostream& seekp( off_type off, std::ios_base::seekdir dir );	(2)

Sets the output position indicator of the current associated streambuf object.

Behaves as UnformattedOutputFunction (except without actually performing output). After constructing and checking the sentry object,

(since C++11)

1) sets the output position indicator to absolute (relative to the beginning of the file) value pos by calling rdbuf()->pubseekpos(pos, std::ios_base::out). If the call returns (pos_type)-1, executes setstate(failbit).

2) sets the output position indicator to offset off relative to dir by calling rdbuf()->pubseekoff(off, dir, std::ios_base::out). If the call returns (pos_type)-1, executes setstate(failbit).

Parameters

pos	-	absolute position to set the output position indicator to.
off	-	relative position (positive or negative) to set the output position indicator to.
dir	-	defines base position to apply the relative offset to. It can be one of the following constants: Constant Explanation beg the beginning of a stream end the ending of a stream cur the current position of stream position indicator

Return value

*this

Exceptions

1-2) May throw std::ios_base::failure in case of failure, if exceptions() & failbit != 0.

Example

Run this code

#include <sstream>
#include <iostream>
 
int main()
{
    std::ostringstream os("hello, world");
    os.seekp(7);
    os << 'W';
    os.seekp(0, std::ios_base::end);
    os << '!';
    os.seekp(0);
    os << 'H';
    std::cout << os.str() << '\n';
}

Output:

Hello, World!

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 2341	C++98	two overloads behaved differently on failure	made consistent

See also

tellp	returns the output position indicator (public member function)
tellg	returns the input position indicator (public member function of std::basic_istream<CharT,Traits>)
seekg	sets the input position indicator (public member function of std::basic_istream<CharT,Traits>)