std::basic_istream< _CharT, _Traits >::sentry(3cxx) | std::basic_istream< _CharT, _Traits >::sentry(3cxx) |
NAME¶
std::basic_istream< _CharT, _Traits >::sentry -SYNOPSIS¶
Public Types¶
typedef
Public Member Functions¶
operator bool () const
Detailed Description¶
template<typename _CharT, typename _Traits>class std::basic_istream< _CharT, _Traits >::sentry¶
Performs setup work for input streams.Member Typedef Documentation¶
template<typename _CharT, typename _Traits> typedef _Traits std::basic_istream< _CharT, _Traits >::sentry::traits_type¶
Easy access to dependant types. Definition at line 636 of file istream.Constructor & Destructor Documentation¶
template<typename _CharT, typename _Traits> std::basic_istream< _CharT, _Traits >::sentry::sentry ( basic_istream< _CharT, _Traits > &__is, bool__noskipws = false) [explicit]¶
The constructor performs all the work. Parameters:is The input stream to guard.
noskipws Whether to consume whitespace or not.
If the stream state is good ( is.good() is true), then the following
actions are performed, otherwise the sentry state is false ('not okay') and
failbit is set in the stream state.
The sentry's preparatory actions are:
- 1.
- if the stream is tied to an output stream, is.tie()->flush() is called to synchronize the output sequence
- 2.
- if noskipws is false, and ios_base::skipws is set in is.flags() , the sentry extracts and discards whitespace characters from the stream. The currently imbued locale is used to determine whether each character is whitespace.
Member Function Documentation¶
template<typename _CharT, typename _Traits> std::basic_istream< _CharT, _Traits >::sentry::operator bool () const [inline]¶
Quick status checking. Returns:The sentry state.
For ease of use, sentries may be converted to booleans. The return value is that
of the sentry state (true == okay).
Definition at line 673 of file istream.
Author¶
Generated automatically by Doxygen for libstdc++ from the source code.Thu Aug 2 2012 | libstdc++ |