std::basic_istream<CharT,Traits>::gcount (3) - Linux Manuals

std::basic_istream<CharT,Traits>::gcount: std::basic_istream<CharT,Traits>::gcount

NAME

std::basic_istream<CharT,Traits>::gcount - std::basic_istream<CharT,Traits>::gcount

Synopsis

std::streamsize gcount() const;

Returns the number of characters extracted by the last unformatted_input_operation.
The following member functions of basic_istream change the value of subsequent gcount() calls:

* move_constructor
* swap()
* get()
* getline()
* ignore()
* read()
* readsome()
* operator>>(basic_streambuf*)

The following functions set gcount() to zero:

* constructor
* putback()
* unget()
* peek()

Parameters

(none)

Return value

The number of characters extracted by the last unformatted input operation

Example

// Run this code

  #include <iostream>
  #include <sstream>

  int main()
  {
      char x[20];
      std::istringstream stream("Hello World");

      stream.read(x, sizeof x);
      std::cout << "Characters extracted: " << stream.gcount();
  }

Output:

  Characters extracted: 11