libstdc++
std::basic_fstream Class Reference
Inheritance diagram for std::basic_fstream:

List of all members.

Public Types

Public Member Functions


Detailed Description

Controlling input and output for files.

This class supports reading from and writing to named files, using the inherited functions from std::basic_iostream. To control the associated sequence, an instance of std::basic_filebuf is used, which this page refers to as sb.


Constructor & Destructor Documentation

std::basic_fstream::basic_fstream ( ) [inline]

Default constructor.

Initializes sb using its default constructor, and passes &sb to the base class initializer. Does not open any files (you haven't given it a filename to open).

Definition at line 788 of file fstream.

std::basic_fstream::basic_fstream ( const char *  __s,
ios_base::openmode  __mode = ios_base::in | ios_base::out 
) [inline, explicit]

Create an input/output file stream.

Parameters:
sNull terminated string specifying the filename.
modeOpen file in specified mode (see std::ios_base).

Tip: When using std::string to hold the filename, you must use .c_str() before passing it to this constructor.

Definition at line 801 of file fstream.

References open().

std::basic_fstream::basic_fstream ( const std::string __s,
ios_base::openmode  __mode = ios_base::in | ios_base::out 
) [inline, explicit]

Create an input/output file stream.

Parameters:
sNull terminated string specifying the filename.
modeOpen file in specified mode (see std::ios_base).

Definition at line 816 of file fstream.

References open().

std::basic_fstream::~basic_fstream ( ) [inline]

The destructor does nothing.

The file is closed by the filebuf object, not the formatting stream.

Definition at line 831 of file fstream.


Member Function Documentation

void std::basic_fstream::close ( ) [inline]

Close the file.

Calls std::basic_filebuf::close(). If that function fails, failbit is set in the stream's error state.

Definition at line 911 of file fstream.

References std::basic_filebuf::close(), and std::ios_base::failbit.

bool std::basic_fstream::is_open ( ) [inline]

Wrapper to test for an open file.

Returns:
rdbuf()->is_open()

Definition at line 850 of file fstream.

References std::basic_filebuf::is_open().

void std::basic_fstream::open ( const char *  __s,
ios_base::openmode  __mode = ios_base::in | ios_base::out 
) [inline]

Opens an external file.

Parameters:
sThe name of the file.
modeThe open mode flags.

Calls std::basic_filebuf::open(s,mode). If that function fails, failbit is set in the stream's error state.

Tip: When using std::string to hold the filename, you must use .c_str() before passing it to this constructor.

Definition at line 871 of file fstream.

References std::basic_filebuf::open(), and std::ios_base::failbit.

Referenced by basic_fstream().

void std::basic_fstream::open ( const std::string __s,
ios_base::openmode  __mode = ios_base::in | ios_base::out 
) [inline]

Opens an external file.

Parameters:
sThe name of the file.
modeThe open mode flags.

Calls std::basic_filebuf::open(s,mode). If that function fails, failbit is set in the stream's error state.

Definition at line 892 of file fstream.

References std::basic_filebuf::open(), and std::ios_base::failbit.

__filebuf_type* std::basic_fstream::rdbuf ( ) const [inline]

Accessing the underlying buffer.

Returns:
The current basic_filebuf buffer.

This hides both signatures of std::basic_ios::rdbuf().

Definition at line 842 of file fstream.


The documentation for this class was generated from the following file: