Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
std::basic_istream::peek(3)   C++ Standard Libary  std::basic_istream::peek(3)

NAME
       std::basic_istream::peek	- std::basic_istream::peek

Synopsis
	  int_type peek();

	  Behaves  as UnformattedInputFunction.	After constructing and testing
       the sentry
	  object, reads	the next character from	the input stream  without  ex-
       tracting	it.

Parameters
	  (none)

Return value
	  If  good()  ==  true,	 returns the next character as obtained	by rd-
       buf()->sgetc()

	  Otherwise, returns Traits::eof().

Exceptions
	  failure if an	error occurred (the error state	flag is	 not  goodbit)
       and exceptions()
	  is set to throw for that state.

	  If  an internal operation throws an exception, it is caught and bad-
       bit is set. If
	  exceptions() is set for badbit, the exception	is rethrown.

Example
       // Run this code

	#include <sstream>
	#include <iostream>
	int main()
	{
	    std::istringstream s1("Hello, world.");
	    char c1 = s1.peek();
	    char c2 = s1.get();
	    std::cout << "Peeked: " << c1 << " got: " << c2 << '\n';
	}

Output:
	Peeked:	H got: H

See also
	  sgetc	reads one character from the input sequence without  advancing
       the sequence
		(public	member function	of std::basic_streambuf<CharT,Traits>)
	  get	extracts characters
		(public	member function)
	  unget	unextracts a character
		(public	member function)

http://cppreference.com		  2022.07.31	   std::basic_istream::peek(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=std::basic_istream::peek&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help