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.

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

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

The FileInfo type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkFileInfoInitializes a new instance of the FileInfo class, which acts as a wrapper for a file path.
Top

  NameDescription
Public propertySupported by the XNA FrameworkAttributesGets or sets the attributes for the current file or directory. (Inherited from FileSystemInfo.)
Public propertySupported by the XNA FrameworkCreationTimeGets or sets the creation time of the current file or directory. (Inherited from FileSystemInfo.)
Public propertyCreationTimeUtcGets or sets the creation time, in coordinated universal time (UTC), of the current file or directory. (Inherited from FileSystemInfo.)
Public propertySupported by the XNA FrameworkDirectoryGets an instance of the parent directory.
Public propertySupported by the XNA FrameworkDirectoryNameGets a string representing the directory's full path.
Public propertySupported by the XNA FrameworkExistsGets a value indicating whether a file exists. (Overrides FileSystemInfo.Exists.)
Public propertySupported by the XNA FrameworkExtensionGets the string representing the extension part of the file. (Inherited from FileSystemInfo.)
Public propertySupported by the XNA FrameworkFullNameGets the full path of the directory or file. (Inherited from FileSystemInfo.)
Public propertyIsReadOnlyGets or sets a value that determines if the current file is read only.
Public propertySupported by the XNA FrameworkLastAccessTimeGets or sets the time the current file or directory was last accessed. (Inherited from FileSystemInfo.)
Public propertyLastAccessTimeUtcGets or sets the time, in coordinated universal time (UTC), that the current file or directory was last accessed. (Inherited from FileSystemInfo.)
Public propertySupported by the XNA FrameworkLastWriteTimeGets or sets the time when the current file or directory was last written to. (Inherited from FileSystemInfo.)
Public propertyLastWriteTimeUtcGets or sets the time, in coordinated universal time (UTC), when the current file or directory was last written to. (Inherited from FileSystemInfo.)
Public propertySupported by the XNA FrameworkLengthGets the size, in bytes, of the current file.
Public propertySupported by the XNA FrameworkNameGets the name of the file. (Overrides FileSystemInfo.Name.)
Top

  NameDescription
Public methodSupported by the XNA FrameworkAppendTextCreates a StreamWriter that appends text to the file represented by this instance of the FileInfo.
Public methodSupported by the XNA FrameworkCopyTo(String)Copies an existing file to a new file, disallowing the overwriting of an existing file.
Public methodSupported by the XNA FrameworkCopyTo(String, Boolean)Copies an existing file to a new file, allowing the overwriting of an existing file.
Public methodSupported by the XNA FrameworkCreateCreates a file.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkCreateTextCreates a StreamWriter that writes a new text file.
Public methodDecryptDecrypts a file that was encrypted by the current account using the Encrypt method.
Public methodSupported by the XNA FrameworkDeletePermanently deletes a file. (Overrides FileSystemInfo.Delete().)
Public methodEncryptEncrypts a file so that only the account used to encrypt the file can decrypt it.
Public methodSupported by the XNA FrameworkEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAccessControl()Gets a FileSecurity object that encapsulates the access control list (ACL) entries for the file described by the current FileInfo object.
Public methodGetAccessControl(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.
Public methodSupported by the XNA FrameworkGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetObjectDataSets the SerializationInfo object with the file name and additional exception information. (Inherited from FileSystemInfo.)
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodSupported by the XNA FrameworkMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodSupported by the XNA FrameworkMoveToMoves a specified file to a new location, providing the option to specify a new file name.
Public methodSupported by the XNA FrameworkOpen(FileMode)Opens a file in the specified mode.
Public methodSupported by the XNA FrameworkOpen(FileMode, FileAccess)Opens a file in the specified mode with read, write, or read/write access.
Public methodSupported by the XNA FrameworkOpen(FileMode, FileAccess, FileShare)Opens a file in the specified mode with read, write, or read/write access and the specified sharing option.
Public methodSupported by the XNA FrameworkOpenReadCreates a read-only FileStream.
Public methodSupported by the XNA FrameworkOpenTextCreates a StreamReader with UTF8 encoding that reads from an existing text file.
Public methodSupported by the XNA FrameworkOpenWriteCreates a write-only FileStream.
Public methodSupported by the XNA FrameworkRefreshRefreshes the state of the object. (Inherited from FileSystemInfo.)
Public methodReplace(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.
Public methodReplace(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.
Public methodSetAccessControlApplies access control list (ACL) entries described by a FileSecurity object to the file described by the current FileInfo object.
Public methodSupported by the XNA FrameworkToStringReturns the path as a string. (Overrides Object.ToString().)
Top

  NameDescription
Protected fieldSupported by the XNA FrameworkFullPathRepresents the fully qualified path of the directory or file. (Inherited from FileSystemInfo.)
Protected fieldSupported by the XNA FrameworkOriginalPathThe path originally specified by the user, whether relative or absolute. (Inherited from FileSystemInfo.)
Top

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

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.

If you are going to reuse an object several times, consider using the instance method of FileInfo instead of the corresponding static methods of the File class, because a security check will not always be necessary.

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.

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());
        }
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft