FileInfo Class

FileInfo Class

 

Provides properties and instance methods for the creation, copying, deletion, moving, and opening of files, and aids in the creation of FileStream objects. This class cannot be inherited.

To browse the .NET Framework source code for this type, see the Reference Source.

Namespace:   System.IO
Assembly:  mscorlib (in mscorlib.dll)


[SerializableAttribute]
[ComVisibleAttribute(true)]
public sealed class FileInfo : FileSystemInfo

NameDescription
System_CAPS_pubmethodFileInfo(String)

Initializes a new instance of the FileInfo class, which acts as a wrapper for a file path.

NameDescription
System_CAPS_pubpropertyAttributes

Gets or sets the attributes for the current file or directory.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyCreationTime

Gets or sets the creation time of the current file or directory.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyCreationTimeUtc

Gets or sets the creation time, in coordinated universal time (UTC), of the current file or directory.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyDirectory

Gets an instance of the parent directory.

System_CAPS_pubpropertyDirectoryName

Gets a string representing the directory's full path.

System_CAPS_pubpropertyExists

Gets a value indicating whether a file exists.(Overrides FileSystemInfo.Exists.)

System_CAPS_pubpropertyExtension

Gets the string representing the extension part of the file.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyFullName

Gets the full path of the directory or file.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyIsReadOnly

Gets or sets a value that determines if the current file is read only.

System_CAPS_pubpropertyLastAccessTime

Gets or sets the time the current file or directory was last accessed.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyLastAccessTimeUtc

Gets or sets the time, in coordinated universal time (UTC), that the current file or directory was last accessed.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyLastWriteTime

Gets or sets the time when the current file or directory was last written to.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyLastWriteTimeUtc

Gets or sets the time, in coordinated universal time (UTC), when the current file or directory was last written to.(Inherited from FileSystemInfo.)

System_CAPS_pubpropertyLength

Gets the size, in bytes, of the current file.

System_CAPS_pubpropertyName

Gets the name of the file.(Overrides FileSystemInfo.Name.)

NameDescription
System_CAPS_pubmethodAppendText()

Creates a StreamWriter that appends text to the file represented by this instance of the FileInfo.

System_CAPS_pubmethodCopyTo(String)

Copies an existing file to a new file, disallowing the overwriting of an existing file.

System_CAPS_pubmethodCopyTo(String, Boolean)

Copies an existing file to a new file, allowing the overwriting of an existing file.

System_CAPS_pubmethodCreate()

Creates a file.

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodCreateText()

Creates a StreamWriter that writes a new text file.

System_CAPS_pubmethodDecrypt()

Decrypts a file that was encrypted by the current account using the Encrypt method.

System_CAPS_pubmethodDelete()

Permanently deletes a file.(Overrides FileSystemInfo.Delete().)

System_CAPS_pubmethodEncrypt()

Encrypts a file so that only the account used to encrypt the file can decrypt it.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetAccessControl()

Gets a FileSecurity object that encapsulates the access control list (ACL) entries for the file described by the current FileInfo object.

System_CAPS_pubmethodGetAccessControl(AccessControlSections)

Gets a FileSecurity object that encapsulates the specified type of access control list (ACL) entries for the file described by the current FileInfo object.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

Sets the SerializationInfo object with the file name and additional exception information.(Inherited from FileSystemInfo.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodMoveTo(String)

Moves a specified file to a new location, providing the option to specify a new file name.

System_CAPS_pubmethodOpen(FileMode)

Opens a file in the specified mode.

System_CAPS_pubmethodOpen(FileMode, FileAccess)

Opens a file in the specified mode with read, write, or read/write access.

System_CAPS_pubmethodOpen(FileMode, FileAccess, FileShare)

Opens a file in the specified mode with read, write, or read/write access and the specified sharing option.

System_CAPS_pubmethodOpenRead()

Creates a read-only FileStream.

System_CAPS_pubmethodOpenText()

Creates a StreamReader with UTF8 encoding that reads from an existing text file.

System_CAPS_pubmethodOpenWrite()

Creates a write-only FileStream.

System_CAPS_pubmethodRefresh()

Refreshes the state of the object.(Inherited from FileSystemInfo.)

System_CAPS_pubmethodReplace(String, String)

Replaces the contents of a specified file with the file described by the current FileInfo object, deleting the original file, and creating a backup of the replaced file.

System_CAPS_pubmethodReplace(String, String, Boolean)

Replaces the contents of a specified file with the file described by the current FileInfo object, deleting the original file, and creating a backup of the replaced file. Also specifies whether to ignore merge errors.

System_CAPS_pubmethodSetAccessControl(FileSecurity)

Applies access control list (ACL) entries described by a FileSecurity object to the file described by the current FileInfo object.

System_CAPS_pubmethodToString()

Returns the path as a string.(Overrides Object.ToString().)

System_CAPS_noteNote

To view the .NET Framework source code for this type, see the Reference Source. You can browse through the source code online, download the reference for offline viewing, and step through the sources (including patches and updates) during debugging; see instructions.

Use the FileInfo class for typical operations such as copying, moving, renaming, creating, opening, deleting, and appending to files.

If you are performing multiple operations on the same file, it can be more efficient to use FileInfo instance methods instead of the corresponding static methods of the File class, because a security check will not always be necessary.

Many of the FileInfo methods return other I/O types when you create or open files. You can use these other types to further manipulate a file. For more information, see specific FileInfo members such as Open, OpenRead, OpenText, CreateText, or Create.

By default, full read/write access to new files is granted to all users.

The following table describes the enumerations that are used to customize the behavior of various FileInfo methods.

Enumeration

Description

FileAccess

Specifies read and write access to a file.

FileShare

Specifies the level of access permitted for a file that is already in use.

FileMode

Specifies whether the contents of an existing file are preserved or overwritten, and whether requests to create an existing file cause an exception.

System_CAPS_noteNote

In members that accept a path as an input string, that path must be well-formed or an exception is raised. For example, if a path is fully qualified but begins with a space, the path is not trimmed in methods of the class. Therefore, the path is malformed and an exception is raised. Similarly, a path or a combination of paths cannot be fully qualified twice. For example, "c:\temp c:\windows" also raises an exception in most cases. Ensure that your paths are well-formed when using methods that accept a path string.

In members that accept a path, the path can refer to a file or just a directory. The specified path can also refer to a relative path or a Universal Naming Convention (UNC) path for a server and share name. For example, all the following are acceptable paths:

  • "c:\\MyDir\\MyFile.txt" in C#, or "c:\MyDir\MyFile.txt" in Visual Basic.

  • "c:\\MyDir" in C#, or "c:\MyDir" in Visual Basic.

  • "MyDir\\MySubdir" in C#, or "MyDir\MySubDir" in Visual Basic.

  • "\\\\MyServer\\MyShare" in C#, or "\\MyServer\MyShare" in Visual Basic.

The FileInfo class provides the following properties that enable you to retrieve information about a file. For an example of how to use each property, see the property pages.

  • The Directory property retrieves an object that represents the parent directory of a file.

  • The DirectoryName property retrieves the full path of the parent directory of a file.

  • The Exists property checks for the presence of a file before operating on it.

  • The IsReadOnly property retrieves or sets a value that specifies whether a file can be modified.

  • The Length retrieves the size of a file.

  • The Name retrieves the name of a file.

The following example demonstrates some of the main members of the FileInfo class.

When the properties are first retrieved, FileInfo calls the Refresh method and caches information about the file. On subsequent calls, you must call Refresh to get the latest copy of the information.

using System;
using System.IO;

class Test 
{

    public static void Main() 
    {
        string path = Path.GetTempFileName();
        FileInfo fi1 = new FileInfo(path);

        //Create a file to write to.
        using (StreamWriter sw = fi1.CreateText()) 
        {
            sw.WriteLine("Hello");
            sw.WriteLine("And");
            sw.WriteLine("Welcome");
        }	

        //Open the file to read from.
        using (StreamReader sr = fi1.OpenText()) 
        {
            string s = "";
            while ((s = sr.ReadLine()) != null) 
            {
                Console.WriteLine(s);
            }
        }

        try 
        {
            string path2 = Path.GetTempFileName();
            FileInfo fi2 = new FileInfo(path2);

            //Ensure that the target does not exist.
            fi2.Delete();

            //Copy the file.
            fi1.CopyTo(path2);
            Console.WriteLine("{0} was copied to {1}.", path, path2);

            //Delete the newly created file.
            fi2.Delete();
            Console.WriteLine("{0} was successfully deleted.", path2);

        } 
        catch (Exception e) 
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}

This example produces output similar to the following.

Hello
And
Welcome
C:\Users\userName\AppData\Local\Temp\tmp70AB.tmp was copied to C:\Users\userName\AppData\Local\Temp\tmp70CB.tmp.
C:\Users\userName\AppData\Local\Temp\tmp70CB.tmp was successfully deleted.

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft