protected virtual member function
<fstream>

std::basic_filebuf::pbackfail

int_type pbackfail (int_type c = traits_type::eof());
Put character back on underflow
Moves the current input position on position back to point to the previous character and, if supported, makes c available as that next character to be read.

If the implementation does not support writing to putback positions, c shall either match the character at the putback position or be the end-of-file value (traits_type::eof()). Otherwise, the function fails. The function uses traits_type::eq for the comparisons, with c converted with traits_type::to_char_type when needed.

If the get pointer (gptr) is at the beginning of the character sequence before the call, the function may either fail or make additional putback positions available and succeed, depending on the library implementation.

In no case the contents of the associated file are modified by the function.

On failure, the function returns the end-of-file value (traits_type::eof()) without altering the get pointer (gptr).

This virtual function is called by public member functions of basic_streambuf such as sungetc and sputbackc when there are no putback positions available at the get pointer (gptr), or when the character being put back does not match the one in the buffer.

This member function overrides the inherited virtual member basic_streambuf::pbackfail.

Parameters

c
Character to be put back, or the end-of-file value (traits_type::eof()) to keep the value of the character at the putback position.
Member type int_type is an integral type able to represent any character value or the special end-of-file value.

Return Value

On success, traits_type::not_eof(c).
The function returns the end-of-file value (traits_type::eof()) on failure.
Member type int_type is an integral type able to represent any character value or the special end-of-file value.

Data races

Modifies the basic_filebuf object.
Concurrent access to the same file stream buffer object may introduce data races.

Exception safety

Basic guarantee: if an exception is thrown, the file stream buffer is in a valid state.

See also