Files Operations in C#

.NET programming topics
Post Reply
Cyclops
Lieutenant
Lieutenant
Posts: 71
Joined: Wed Jul 15, 2009 1:48 pm
Location: London

Files Operations in C#

Post by Cyclops » Tue Nov 10, 2009 5:32 pm

Routine Operations on Files

Opening a File

As opposed to creating a file, probably the second most regular operation performed on a file consists of opening it to read or explore its contents. To support opening a file, the FileInfo class is equipped with the Open() method that is overloaded with three versions.

If you have a text-based file and want to directly read from it, you can use the StreamReader class that is equipped with the Read() and the ReadLine() methods. As done for the StreamWriter class, after using a StreamReader object, make sure you close it

Deleting a File

If you have an existing file you don't need anymore, you can delete it. This operation can be performed by calling the FileInfo.Delete() method. Its syntax is:

public override void Delete();

Here is an example:

Code: Select all

using System;
using System.IO;

public class Program
{
    static int Main(string[] args)
    {
        var fleMembers = new FileInfo("First.txt");

        if (fleMembers.Exists == true)
            fleMembers.Delete();

        return 0;
    }
}

Copying a File

You can make a copy of a file from one directory to another. To do this, you can call the FileInfo.CopyTo() method that is overloaded with two versions. The first version has the following syntax:
public FileInfo CopyTo(string destFileName);

When calling this method, specify the path or directory that will be the destination of the copied file. Here is an example:

Code: Select all

using System;
using System.IO;

public class Program
{
    static int Main(string[] args)
    {
        var fleMembers = new FileInfo("Reality.txt");
        var strMyDocuments =
            Environment.GetFolderPath(Environment.SpecialFolder.Personal);

        if (fleMembers.Exists == true)
            fleMembers.CopyTo(string.Concat(strMyDocuments, "\\Federal.txt"));

        return 0;
    }
}
In this example, a file named Reality.txt in the directory of the project would be retrieved and its content would be applied to a new file named Federal.txt created in the My Documents folder of the current user.

When calling the first version of the FileInfo.CopyTo() method, if the file exists already, the operation would not continue and you would simply receive a message box. If you insist, you can overwrite the target file. To do this, you can use the second version of this method. Its syntax is:

public FileInfo CopyTo(string destFileName, bool overwrite);

The first argument is the same as that of the first version of the method. The second argument specifies what action to take if the file exists already in the target directory. If you want to overwrite it, pass the argument as true; otherwise, pass it as false.


Moving a File

If you copy a file from one directory to another, you would have two copies of the same file or the same contents in two files. Instead of copying, if you want, you can simply move the file from one directory to another. This operation can be performed by calling the FileInfo.MoveTo() method. Its syntax is:
public void MoveTo(string destFileName);

The argument to this method is the same as that of the CopyTo() method. After executing this method, the FileInfo object would be moved to the destFileName path.

Here is an example:

Code: Select all

using System;
using System.IO;

public class Program
{
    static int Main(string[] args)
    {
        var fleMembers = new FileInfo("pop.txt");
        var strMyDocuments =
            Environment.GetFolderPath(Environment.SpecialFolder.Personal);

        if (fleMembers.Exists == true)
            fleMembers.MoveTo(string.Concat(strMyDocuments, "\\Federal.txt"));

        return 0;
    }
}

Characteristics of a File


The Date and Time a File Was Created

To keep track of it, after a file has been created, the operating system makes a note of the date and the time the file was created. This information can be valuable in other operations such as search routines. You too are allowed to change this date and time values to those you prefer.

As mentioned already, the OS makes sure to keep track of the date and time a file was created. To find out what those date and time values are, you can access the FileSystemInfo.CreationTime property. This would be done as follows:

Code: Select all

using System;
using System.IO;

public class Program
{
    static int Main(string[] args)
    {
        var SomeFile = new FileInfo("First.txt");
        DateTime dteCreationTime = SomeFile.CreationTime;

        if (SomeFile.Exists == true)
            Console.WriteLine("Date and Time Created: " +
                dteCreationTime.ToString());

        return 0;
    }
}
Of course, by entering the appropriate format in the parentheses of the ToString() method, you can get only either the date or only the time.

If you don't like the date, the time, or both, that the OS would have set when the file was created, you can change them. To change one or both of these values, you can assign a desired DateTime object to the FileSystemInfo.set_CreationTime() property.


The Date and Time a File Was Last Accessed

Many applications allow a user to open an existing file and to modify it. When people work in a team or when a particular file is regularly opened, at one particular time, you may want to know the date and time that the file was last accessed. To get this information, you can access the FileSystemInfo.LastAccessTime property.

If you are interested to know the last date and time a file was modified, you can get the value of its FileSystemInfo.LastWriteTime property.


The Name of a File

The operating system requires that each file have a name. In fact, the name must be specified when creating a file. This allows the OS to catalogue the computer files. This also allows you to locate or identify a particular file you need.

When reviewing or opening a file, to get its name, the FileInfo class is equipped with the Name property. Here is an example:

Code: Select all

using System;
using System.IO;

public class Program
{
    static int Main(string[] args)
    {
        var SomeFile = new FileInfo("Persons.spr");

        if (SomeFile.Exists == true)
            Console.WriteLine("The name of this file is: \"" + 
		SomeFile.Name + "\"");

        return 0;
    }
}
This string simply identifies a file.

The Extension of a File

With the advent of Windows 95 and later, the user doesn't have to specify the extension of a file when creating it. Because of the type of confusion that this can lead to, most applications assist the user with this detail. Some applications allow the user to choose among various extensions. For example, using Notepad, a user can open a text, a PHP, a script, or an HTML file.

When you access a file or when the user opens one, to know the extension of the file, you can access the value of the FileSystemInfo.Extension property. Here is an example:

Code: Select all

using System;
using System.IO;

public class Program
{
    static int Main(string[] args)
    {
        var SomeFile = new FileInfo("Persons.spr");

        if (SomeFile.Exists == true)
            Console.WriteLine("File Extension: " + SomeFile.Extension);

        return 0;
    }
}
This would produce:
File Extension: .spr
Press any key to continue . . .


The Size of a File

One of the routine operations the operating system performs consists of calculating the sizes of files it holds. This information is provided in terms of bits, kilobits, or kilobytes. To get the size of a file, the FileInfo class is quipped with the Length property. Here is an example of accessing it:

Code: Select all

using System;
using System.IO;

public class Program
{
    static int Main(string[] args)
    {
        var SomeFile = new FileInfo("Persons.spr");

        if (SomeFile.Exists == true)
            Console.WriteLine("File Size: " + 
                SomeFile.Length.ToString());

        return 0;
    }
}
Here is an example of what this would produce:
File Size: 57
Press any key to continue . . .


The Path to a File

Besides the name of the file, it must be located somewhere. The location of a file is referred to as its path or directory. The FileInfo class represents this path as the DirectoryName property. Therefore, if a file has already been created, to get its path, you can access the value of the FileInfo.DirectoryName property.

Besides the FileInfo.Directoryname, to know the full path to a file, you can access its FileSystemInfo.FullName property.


The Attributes of a File

Attributes are characteristics that apply to a file, defining what can be done or must be disallowed on it. The Attributes are primarily defined by, and in, the operating system, mostly when a file is created. When the user accesses or opens a file, to get its attributes, you can access the value of its FileSystemInfo.Attributes property. This property produces a FileAttributes object.

When you create or access a file, you can specify or change some of the attributes. To do this, you can a FileAttributes object and assign it to the FileSystemInfo.Attributes property.

FileAttributes is an enumerator with the following members: Archive, Compressed, Device, Directory, Encrypted, Hidden, Normal, NotContentIndexed, Offline, ReadOnly, ReparsePoint, SparseFile, System, and Temporary.


Directories

Introduction

A directory is a section of a medium used to delimit a group of files. Because it is a "physical" area, it can handle operations not available on files. In fact, there are many fundamental differences between both:
A file is used to contain data. A directory doesn't contain data
A directory can contain one or more files and not vice-versa
A directory can contain other directories
A file can be moved from one directory to another. This operation is not possible vice-versa since a file cannot contain a directory

The similarities of both types are:
A directory or a file can be created. One of the restrictions is that two files cannot have the same name inside of the same directory. Two directories cannot have the same name inside of the same parent directory.
A directory or a file can be renamed. If a directory is renamed, the "path" of its file(s) changes
A directory or a file can be deleted. If a directory is deleted, its files are deleted also
A directory or a file can be moved. If a directory moves, it "carries" all of its files to the new location
A directory or a file can be copied. A file can be copied from one directory to another. If a directory is copied to a new location, all of its files are also copied to the new location


Directory Creation

Before using a directory, you must first have it. You can use an existing directory if the operating system or someone else had already created one. You can also create a new directory. Directories are created and managed by various classes but the fundamental class is Directory. Directory is a static class, which means all of its methods are static, which means you will never need to declare an instance of the Directory class in order to use it.

Besides the Directory class, additional operations of folders and sub-folders can be performed using the DirectoryInfo class.

To create a directory, you can call the CreateDirectory() method of the Directory class. This method is available in two versions. One of the versions uses the following syntax:
public static DirectoryInfo CreateDirectry(string path);

This method takes as argument the (complete) path of the desired directory. Here is an example:
E:\Programs\Business Orders\Customer Information

When this method is called:
It first checks the parent drive, in this case E.
If the drive doesn't exist, because this method cannot create a drive, the compiler would throw a DirectoryNotFoundException exception
If the drive (in this case E) exists, the compiler moves to the first directory part of the path; in this case this would be the Programs folder in the E drive.
If the folder doesn't exist, the compiler would create it. If that first director doesn't exist, this means that the other directory(ies), if any, under the first don't exist. So, the compiler would create it/them
If the first directory exists and if there is no other directory under that directory, the compiler would stop and would not do anything further.
If the directory exists and there is a sub-directory specified under it, the compiler would check the existence of that directory.
If the sub-directory exists, the compiler would not do anything further and would stop.
If the sub-directory doesn't exist, the compiler would create it
The compiler would repeat step 4 until the end of the specified path

The Directory.CreateDirectory() method returns a DirectoryInfo object that you can use as you see fit.


Checking for a Directory Existence

Before using or creating a directory, you can first check if it exists. This is because, if a directory already exists in the location where you want to create it, you would be prevented from creating one with the same name. In the same way, if you just decide to directly use a directory that doesn't exist, the operation you want to perform may fail because the directory would not be found.

Before using or creating a directory, to first check whether it exists or not, you can call the Directory.Exists() Boolean method. Its syntax is:
public static bool Exists(string path);

This method receives the (complete) path of the directory. If the path exists, the method returns true. If the directory doesn't exist, the method returns false.

To create a directory, you can call the CreateDirectory() method of the Directory class.


Locating a File

One of the most routine operations performed in a directory consists of looking for a file. Both Microsoft Windows operating systems and the user's intuition have different ways of addressing this issue. The .NET Framework also provides its own means of performing this operation, through various techniques. You can start by checking the sub-directories and files inside of a main directory.

To look for files in a directory, the DirectoryInfo class can assist you with its GetFiles() method, which is overloaded with three versions.
Post Reply

Return to “.NET Programming”