std::streamoff

 

C++

Compiler support

Freestanding and hosted

Language

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General 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)

Concurrency support library (C++11)

Technical specifications

Symbols index

External libraries

 

Input/output library

I/O manipulators

C-style I/O

Buffers

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

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

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

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)

 

Defined in header <ios>
typedef /*implementation-defined*/ streamoff;

The type std::streamoff is an implementation-defined signed integral (since C++11) type of sufficient size to represent the maximum possible file size supported by the operating system. Typically, this is an alias for long long. (since C++11)

It is used to represent offsets from stream positions (values of type std::fpos). A std::streamoff value constructed from -1 is also used to represent error conditions by some of the I/O library functions.

Relationship with std::fpos

• the difference between two std::fpos objects is a value of type std::streamoff

• a value of type std::streamoff may be added or subtracted from std::fpos yielding a different std::fpos.

• a value of type std::fpos is implicitly convertible to std::streamoff (the conversion result is the offset from the beginning of the file).

• a value of type std::fpos is constructible from a value of type std::streamoff

See also

fpos	represents absolute position in a stream or a file (class template)
seekg	sets the input position indicator (public member function of std::basic_istream<CharT,Traits>)
seekp	sets the output position indicator (public member function of std::basic_ostream<CharT,Traits>)