ProjectsWebsiteBlog

Files - NKS0018

Use Checking.FileExists()

This analyzer provides the following strings:

Context
String

Error List

Caller uses File.Exists instead of Checking.FileExists()

Suggestion Box

Use Checking.FileExists() instead of File.Exists

Description

Checking.FileExists() neutralizes the provided path to its absolute correct path, while File.Exists operates at the executable directory (Environment.CurrentDirectory), which may not be what you want.

Extended Description

This code analyzer detects the usage of Exists from the standard File class found in the System.IO namespace.

Using File.Exists(), path neutralization doesn't take place to ensure that we have the correct absolute path. This causes some of the filesystem operations to operate on files, which are located in the wrong place, and, therefore, errors throw about a target not being found.

A solution to this problem was made with FileExists(), because it takes care of the absolute paths and tries to reduce this kind of error caused by passing relative directories to the arguments.

Analysis Comparison

To get a brief insight about how this analyzer works, compare the two code blocks shown to you below:

Before the fix

Somewhere in your mod code...
public static void MyFunction()
{
    File.Exists("test.txt");
}

After the fix

Somewhere in your mod code...
public static void MyFunction()
{
    Checking.FileExists("test.txt");
}

Suppression

You can suppress this suggestion by including it in the appropriate place, whichever is convenient.

For more information about how to suppress any warning issued by the Nitrocid analyzer, visit the below page:

Recommendation

We recommend that every caller which use this function use the recommended abovementioned method.