char_traits::not_eof

Tests whether a character is not the end-of-file (EOF) character or is the EOF.

static int_type not_eof(
   const int_type& _Ch
);

Parameters

  • _Ch
    The character represented as an int_type to be tested for whether it is the EOF character or not.

Return Value

The int_type representation of the character tested, if the int_type of the character is not equal to that of the EOF character.

If the character int_type value is equal to the EOF int_type value, then false.

Example

// char_traits_not_eof.cpp
// compile with: /EHsc
#include <string>
#include <iostream>

int main( ) {
   using namespace std;

   char_traits<char>::char_type ch1 =  'x';
   char_traits<char>::int_type int1;
   int1 = char_traits<char>:: to_int_type ( ch1 );
   cout << "The char_type ch1 is " << ch1
        << " corresponding to int_type: " 
        << int1 << "." << endl;
   
   // EOF member function
   char_traits <char>::int_type int2 = char_traits<char>::eof ( );
   cout << "The eofReturn is: " << int2 << endl;

   // Testing for EOF or another character
   char_traits <char>::int_type eofTest1, eofTest2;
   eofTest1 = char_traits<char>::not_eof ( int1 );
   if ( !eofTest1 )
      cout << "The eofTest1 indicates ch1 is an EOF character."
              << endl;
   else
      cout << "The eofTest1 returns: " << eofTest1 
           << ", which is the character: " 
           <<  char_traits<char>::to_char_type ( eofTest1 )
           << "." << endl;

   eofTest2 = char_traits<char>::not_eof ( int2 );
   if ( !eofTest2 )
      cout << "The eofTest2 indicates int2 is an EOF character." 
           << endl;
   else
      cout << "The eofTest1 returns: " << eofTest2 
           << ", which is the character: " 
           <<  char_traits<char>::to_char_type ( eofTest2 ) 
           << "." << endl;
}

The char_type ch1 is x corresponding to int_type: 120.
The eofReturn is: -1
The eofTest1 returns: 120, which is the character: x.
The eofTest2 indicates int2 is an EOF character.

Requirements

Header: <string>

Namespace: std

See Also

Concepts

char_traits Struct

char_traits Members