CODEWITHSUNDEEP
c++linuxfilefstreamexists
Jerry
Jerry

Reputation: 1149

How to check if a file exists and is readable in C++?

I've got a fstream my_file("test.txt"), but I don't know if test.txt exists. In case it exists, I would like to know if I can read it, too. How to do that?

I use Linux.

Upvotes: 66

Views: 93899

Answers (8)

Adam Badura
Adam Badura

Reputation: 5349

You might use Boost.Filesystem. It has a boost::filesystem::exist function.

I don't know how about checking read access rights. You could look in Boost.Filesystem too. However likely there will be no other (portable) way than try to actually read the file.

EDIT (2021-08-26): C++17 introduced <filesystem> and there you have std::filesystem::exists. Boost is no longer needed for this.

Upvotes: 22

Richard
Richard

Reputation: 8758

C++17, cross-platform: Check file existence with std::filesystem::exists and readability with std::filesystem::status & std::filesystem::perms:

#include <iostream>
#include <filesystem> // C++17
namespace fs = std::filesystem;

/*! \return True if owner, group and others have read permission,
            i.e. at least 0444.
*/
bool IsReadable(const fs::path& p)
{
    std::error_code ec; // For noexcept overload usage.
    auto perms = fs::status(p, ec).permissions();
    if ((perms & fs::perms::owner_read) != fs::perms::none &&
        (perms & fs::perms::group_read) != fs::perms::none &&
        (perms & fs::perms::others_read) != fs::perms::none
        )
    {
        return true;
    }
    return false;
}

int main()
{
    fs::path filePath("path/to/test.txt");
    std::error_code ec; // For noexcept overload usage.
    if (fs::exists(filePath, ec) && !ec)
    {
        if (IsReadable(filePath))
        {
            std::cout << filePath << " exists and is readable.";
        }
    }
}

Consider also checking for the file type.

Upvotes: 12

Vadzim
Vadzim

Reputation: 26210

Since C++11 it's possible to use implicit operator bool instead of good():

ifstream my_file("test.txt");
if (my_file) {
  // read away
}

Upvotes: 6

Kim Gr&#228;sman
Kim Gr&#228;sman

Reputation: 7596

I would probably go with:

ifstream my_file("test.txt");
if (my_file.good())
{
  // read away
}

The good method checks if the stream is ready to be read from.

Upvotes: 89

Drew Chapin
Drew Chapin

Reputation: 8009

I know the poster eventually said they were using Linux, but I'm kind of surprised that no one mentioned the PathFileExists() API call for Windows.

You will need to include the Shlwapi.lib library, and Shlwapi.h header file. 

#pragma comment(lib, "shlwapi.lib")
#include <shlwapi.h>

the function returns a BOOL value and can be called like so:

if( PathFileExists("C:\\path\\to\\your\\file.ext") )
{
    // do something
}

Upvotes: 2

Antoni
Antoni

Reputation: 2632

Concerning the use of fstat in windows, I am not sure if it is what you want. From Microsoft the file must be already open. Stat should work for you.

Upvotes: 0

neoneye
neoneye

Reputation: 52231

if you are on unix then access() can tell you if it's readable. However if ACL's are in use, then it gets more complicated, in this case it's best to just open the file with ifstream and try read.. if you cannot read then the ACL may prohibit reading.

Upvotes: 11

Pablo Santa Cruz
Pablo Santa Cruz

Reputation: 181460

What Operating System/platform?

On Linux/Unix/MacOSX, you can use fstat.

On Windows, you can use GetFileAttributes.

Usually, there is no portable way of doing this with standard C/C++ IO functions.

Upvotes: 10

Related Questions