cplusplus.com cplusplus.com
cplusplus.com   C++ : Reference : IOstream Library : fstream : open
- -
C++
Information
Documentation
Reference
Articles
Sourcecode
Forum
Reference
C Library
IOstream Library
Strings library
STL Containers
STL Algorithms
IOstream Library
manipulators
classes:
· filebuf
· fstream
· ifstream
· ios
· iostream
· ios_base
· istream
· istringstream
· ofstream
· ostream
· ostringstream
· streambuf
· stringbuf
· stringstream
objects:
· cerr
· cin
· clog
· cout
types:
· fpos
· streamoff
· streampos
· streamsize
fstream
· fstream::fstream
member functions:
· fstream::close
· fstream::is_open
· fstream::open
· fstream::rdbuf

-

fstream::open public member function
void open ( const char * filename,
            ios_base::openmode mode = ios_base::in | ios_base::out );

Open file

Opens a file whose name is s, associating its content with the stream object to perform input/output operations on it. The operations allowed and some operating details depend on parameter mode.

The function effectively calls rdbuf()->open(filename,mode).

If the object already has a file associated (open), the function fails.

On failure, the failbit flag is set (which can be checked with member fail), and depending on the value set with exceptions an exception may be thrown.

Parameters

filename
C-string containing the name of the file to be opened.
mode
Flags describing the requested i/o mode for the file. This is an object of type ios_base::openmode, which consists on a combination of one or more of the following flags defined as member constants:
flag valueopening mode
app(append) Set the stream's position indicator to the end of the stream before each output operation.
ate(at end) Set the stream's position indicator to the end of the stream on opening.
binary(binary) Consider stream as binary rather than text.
in(input) Allow input operations on the stream.
out(output) Allow output operations on the stream.
trunc(truncate) Any current content is discarded, assuming a length of zero on opening.

Return Value

none

Example

// fstream::open
#include <fstream>
using namespace std;

int main () {

  fstream filestr;

  filestr.open ("test.txt", fstream::in | fstream::out | fstream::app);

  // >> i/o operations here <<

  filestr.close();

  return 0;
}

This example opens a file to append content.

Basic template member declaration

( basic_fstream<charT,traits> )
void open ( const char * filename, ios_base::openmode mode = ios_base::in | ios_base::out );

See also

fstream::close Close file (public member function)
fstream::fstream Construct object and optionally open file (constructor member)

© The C++ Resources Network, 2000-2007 - All rights reserved
Spotted an error? - contact us