std::basic_ifstream::open

Parameters

filename

String with the name of the file to open.
Specifics about its format and validity depend on the library implementation and running environment.

mode

Flags describing the requested i/o mode for the file.
This is an object of the bitmask member type openmode that consists of a combination of the following member constants:

member constant	stands for	access
in *	input	File open for reading: the internal stream buffer supports input operations.
out	output	File open for writing: the internal stream buffer supports output operations.
binary	binary	Operations are performed in binary mode rather than text.
ate	at end	The output position starts at the end of the file.
app	append	All output operations happen at the end of the file, appending to its existing contents.
trunc	truncate	Any contents that existed in the file before it is open are discarded.

These flags can be combined with the bitwise OR operator (|).
* in is always set for basic_ifstream objects (even if explicitly not set in argument mode).
Note that even though basic_ifstream is an input stream, its internal basic_filebuf object may be set to also support output operations.

If the mode has app set, the opening operation fails. It also fails if trunc is set but out is not.

If the mode has both trunc and app set, the opening operation fails. It also fails if trunc is set but out is not.

Return Value

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// print the content of a text file.
#include <iostream> // std::cout
#include <fstream> // std::ifstream
int main () {
 std::ifstream ifs;
 ifs.open ("test.txt", std::ifstream::in);
 char c = ifs.get();
 while (ifs.good()) {
 std::cout << c;
 c = ifs.get();
 }
 ifs.close();
 return 0;
}

Data races

Exception safety

See also

basic_ifstream::is_open

Check if file is open (public member function)

basic_ifstream::close

Close file (public member function)

basic_filebuf::open

Open file (public member function)