std::basic_filebuf<CharT,Traits>::open (3) - Linux Man Pages

std::basic_filebuf<CharT,Traits>::open: std::basic_filebuf<CharT,Traits>::open

NAME

std::basic_filebuf<CharT,Traits>::open - std::basic_filebuf<CharT,Traits>::open

Synopsis


std::basic_filebuf<CharT, Traits>* open( const char* s, (1)
std::ios_base::openmode mode )
std::basic_filebuf<CharT, Traits>* open( const std::string& str, (2) (since C++11)
std::ios_base::openmode mode )
std::basic_filebuf<CharT, Traits>* open( const std::filesystem::path& p, (3) (since C++17)
std::ios_base::openmode mode )
std::basic_filebuf<CharT, Traits>* open( const std::filesystem::path::value_type* s, (4) (since C++17)
std::ios_base::openmode mode )


Opens the file with the given name (s
, p.c_str()
(since C++17) or str.c_str(), depending on the overload).


Overload (4) is only provided if std::filesystem::path::value_type is not char. (since C++17)


The file is opened as if by calling std::fopen with the second argument (mode) determined as follows:


mode openmode & ~ate Action if file already exists Action if file does not exist
"r" in Read from start Failure to open
"w" out, out|trunc Destroy contents Create new
"a" app, out|app Append to file Create new
"r+" out|in Read from start Error
"w+" out|in|trunc Destroy contents Create new
"a+" out|in|app, in|app Write to end Create new
"rb" binary|in Read from start Failure to open
"wb" binary|out, binary|out|trunc Destroy contents Create new
"ab" binary|app, binary|out|app Write to end Create new
"r+b" binary|out|in Read from start Error
"w+b" binary|out|in|trunc Destroy contents Create new
"a+b" binary|out|in|app, binary|in|app Write to end Create new


If openmode is not one of the modes listed, the open() fails.
If the open operation succeeds and openmode & std::ios_base::ate != 0 (the ate bit is set), repositions the file position to the end of file, as if by calling std::fseek(file, 0, SEEK_END), where file is the pointer returned by calling fopen. If the repositioning fails, calls close() and returns a null pointer to indicate failure.
If the associated file was already open, returns a null pointer right away.

Parameters


s, str, p - the file name to open; s must point to a null-terminated string
openmode - the file opening mode, a binary OR of the std::ios_base modes

Return value


this on success, a null pointer on failure.

Notes


open() is typically called through the constructor or the open() member function of std::basic_fstream.

Example


 This section is incomplete
 Reason: no example

See also


        checks if the associated file is open
is_open (public member function)
        flushes the put area buffer and closes the associated file
close (public member function)