File 類別

定義

提供建立、複製、刪除、移動和開啟單一檔案的靜態方法,並協助 FileStream 物件的建立。

public ref class File abstract sealed
public ref class File sealed
public static class File
public sealed class File
[System.Runtime.InteropServices.ComVisible(true)]
public static class File
type File = class
[<System.Runtime.InteropServices.ComVisible(true)>]
type File = class
Public Class File
Public NotInheritable Class File
繼承
File
屬性

範例

下列範例示範如何使用 File 類別來檢查檔案是否存在,並根據結果建立新檔案並寫入檔案,或開啟現有檔案並從中讀取。 執行程式碼之前,請先建立 c:\temp 資料夾。

using namespace System;
using namespace System::IO;
int main()
{
   String^ path = "c:\\temp\\MyTest.txt";
   if (  !File::Exists( path ) )
   {
      
      // Create a file to write to.
      StreamWriter^ sw = File::CreateText( path );
      try
      {
         sw->WriteLine( "Hello" );
         sw->WriteLine( "And" );
         sw->WriteLine( "Welcome" );
      }
      finally
      {
         if ( sw )
                  delete (IDisposable^)(sw);
      }
   }

   // Open the file to read from.
   StreamReader^ sr = File::OpenText( path );
   try
   {
      String^ s = "";
      while ( s = sr->ReadLine() )
      {
         Console::WriteLine( s );
      }
   }
   finally
   {
      if ( sr )
            delete (IDisposable^)(sr);
   }

   try
   {
      String^ path2 = String::Concat( path, "temp" );
      
      // Ensure that the target does not exist.
      File::Delete( path2 );
      
      // Copy the file.
      File::Copy( path, path2 );
      Console::WriteLine( "{0} was copied to {1}.", path, path2 );
      
      // Delete the newly created file.
      File::Delete( path2 );
      Console::WriteLine( "{0} was successfully deleted.", path2 );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "The process failed: {0}", e );
   }
}
using System;
using System.IO;

class Test
{
    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";
        if (!File.Exists(path))
        {
            // Create a file to write to.
            using (StreamWriter sw = File.CreateText(path))
            {
                sw.WriteLine("Hello");
                sw.WriteLine("And");
                sw.WriteLine("Welcome");
            }
        }

        // Open the file to read from.
        using (StreamReader sr = File.OpenText(path))
        {
            string s;
            while ((s = sr.ReadLine()) != null)
            {
                Console.WriteLine(s);
            }
        }
    }
}
Imports System.IO

Public Class Test
    Public Shared Sub Main()
        Dim path As String = "c:\temp\MyTest.txt"
        If File.Exists(path) = False Then
            ' Create a file to write to.
            Using sw As StreamWriter = File.CreateText(path)
                sw.WriteLine("Hello")
                sw.WriteLine("And")
                sw.WriteLine("Welcome")
           End Using
        End If

        ' Open the file to read from.
        Using sr As StreamReader = File.OpenText(path)
            Do While sr.Peek() >= 0
                Console.WriteLine(sr.ReadLine())
            Loop
        End Using
    End Sub
End Class

備註

針對 File 一般作業使用 類別,例如一次複製、移動、重新命名、建立、開啟、刪除和附加至單一檔案。 您也可以使用 File 類別來取得和設定檔案屬性,或 DateTime 與建立、存取和寫入檔案相關的資訊。 如果您想要對多個檔案執行作業,請參閱 Directory.GetFilesDirectoryInfo.GetFiles

當您建立或開啟檔案時, File 許多方法都會傳回其他 I/O 類型。 您可以使用這些其他類型的來進一步操作檔案。 如需詳細資訊,請參閱特定 File 成員,例如 OpenTextCreateTextCreate

由於所有 File 方法都是靜態的,因此如果您想要只執行一個 File 動作,可能更有效率地使用方法,而不是對應的 FileInfo 實例方法。 所有 File 方法都需要您要操作之檔案的路徑。

類別的 File 靜態方法會對所有方法執行安全性檢查。 如果您要重複使用物件數次,請考慮改用 對應的實例方法 FileInfo ,因為安全性檢查不一定是必要的。

根據預設,會將新檔案的完整讀取/寫入存取權授與所有使用者。

下表描述用來自訂各種 File 方法行為的列舉。

列舉型別 描述
FileAccess 指定檔案的讀取和寫入存取權。
FileShare 指定已使用之檔案允許的存取層級。
FileMode 指定是否保留或覆寫現有檔案的內容,以及建立現有檔案的要求是否造成例外狀況。

注意

在接受路徑做為輸入字串的成員中,該路徑的格式必須正確或引發例外狀況。 例如,如果路徑為完整,但以空格開頭,則不會在 類別的方法中修剪路徑。 因此,路徑的格式不正確,而且會引發例外狀況。 同樣地,路徑或路徑組合不能完整兩次。 例如,在大部分情況下,「c:\temp c:\windows」 也會引發例外狀況。 使用接受路徑字串的方法時,請確定您的路徑格式正確。

在接受路徑的成員中,路徑可以參考檔案或只參考目錄。 指定的路徑也可以參考伺服器和共用名稱的相對路徑或通用命名慣例 (UNC) 路徑。 例如,下列所有都是可接受的路徑:

  • "c:\\\MyDir\\\MyFile.txt"在 C# 或 "c:\MyDir\MyFile.txt" Visual Basic 中。

  • "c:\\\MyDir"在 C# 或 "c:\MyDir" Visual Basic 中。

  • "MyDir\\\MySubdir"在 C# 或 "MyDir\MySubDir" Visual Basic 中。

  • "\\\\\\\MyServer\\\MyShare"在 C# 或 "\\\MyServer\MyShare" Visual Basic 中。

如需一般 I/O 工作的清單,請參閱 一般 I/O 工作

方法

AppendAllLines(String, IEnumerable<String>)

在檔案中加入幾行內容,然後關閉檔案。 如果指定的檔案不存在,則這個方法會建立檔案,將指定的程式行寫入檔案,然後關閉檔案。

AppendAllLines(String, IEnumerable<String>, Encoding)

使用指定編碼將指定的幾行內容加入檔案,然後關閉檔案。 如果指定的檔案不存在,則這個方法會建立檔案,將指定的程式行寫入檔案,然後關閉檔案。

AppendAllLinesAsync(String, IEnumerable<String>, CancellationToken)

以非同步方式在檔案中附加幾行內容,然後關閉檔案。 如果指定的檔案不存在,則這個方法會建立檔案,將指定的程式行寫入檔案,然後關閉檔案。

AppendAllLinesAsync(String, IEnumerable<String>, Encoding, CancellationToken)

使用指定編碼方式以非同步方式在檔案中附加幾行內容,然後關閉檔案。 如果指定的檔案不存在,則這個方法會建立檔案,將指定的程式行寫入檔案,然後關閉檔案。

AppendAllText(String, String)

開啟檔案,將指定的字串附加至檔案,然後關閉檔案。 如果檔案不存在,則這個方法會建立檔案,將指定的字串寫入檔案,然後關閉檔案。

AppendAllText(String, String, Encoding)

使用指定編碼方式將指定字串附加至檔案,如果檔案不存在,請建立一個新檔案。

AppendAllTextAsync(String, String, CancellationToken)

以非同步方式開啟檔案或建立檔案 (如果檔案不存在),並將指定的字串附加至檔案,然後關閉檔案。

AppendAllTextAsync(String, String, Encoding, CancellationToken)

以非同步方式開啟檔案或建立檔案 (如果檔案不存在),並使用指定編碼方式將指定的字串附加至檔案,然後關閉檔案。

AppendText(String)

建立會將 UTF-8 編碼的文字附加至現有檔案或新檔案 (如果指定的檔案不存在) 的 StreamWriter

Copy(String, String)

複製現有的檔案到新的檔案。 不允許覆寫相同名稱的檔案。

Copy(String, String, Boolean)

複製現有的檔案到新的檔案。 允許覆寫相同名稱的檔案。

Create(String)

在指定的路徑中建立或覆寫檔案。

Create(String, Int32)

建立或覆寫指定路徑中的檔案,並指定緩衝區大小。

Create(String, Int32, FileOptions)

建立或覆寫指定路徑中的檔案,並指定緩衝區大小以及描述如何建立或覆寫檔案的選項。

Create(String, Int32, FileOptions, FileSecurity)

建立或覆寫指定路徑中的檔案,並指定緩衝區大小、描述如何建立或覆寫檔案的選項,以及決定檔案存取控制與稽核安全性的值。

CreateSymbolicLink(String, String)

建立指向 的 path pathToTarget 檔案符號連結。

CreateText(String)

建立或開啟用以寫入 UTF-8 編碼文字的檔案。 如果檔案已經存在,將覆寫其內容。

Decrypt(String)

解密目前帳戶使用 Encrypt(String) 方法加密的檔案。

Delete(String)

刪除指定的檔案。

Encrypt(String)

加密檔案,只有使用加密檔案的帳戶才能將其解密。

Exists(String)

判斷指定的檔案是否存在。

GetAccessControl(String)

取得 FileSecurity 物件,該物件封裝指定檔案的存取控制清單 (ACL) 項目。

GetAccessControl(String, AccessControlSections)

取得 FileSecurity 物件,該物件會封裝特定檔案之指定類型的存取控制清單 (ACL) 項目。

GetAttributes(String)

取得路徑上檔案的 FileAttributes

GetCreationTime(String)

傳回指定檔案或目錄的建立日期和時間。

GetCreationTimeUtc(String)

傳回指定檔案或目錄的建立日期和時間,格式為國際標準時間 (UTC)。

GetLastAccessTime(String)

傳回指定檔案或目錄上次被存取的日期和時間。

GetLastAccessTimeUtc(String)

傳回指定檔案或目錄上次被存取的日期和時間,格式為國際標準時間 (UTC)。

GetLastWriteTime(String)

傳回指定檔案或目錄上次被寫入的日期和時間。

GetLastWriteTimeUtc(String)

傳回指定檔案或目錄上次被寫入的日期和時間,格式為國際標準時間 (UTC)。

Move(String, String)

移動指定的檔案至新的位置,提供指定新檔名的選項。

Move(String, String, Boolean)

將指定的檔案移至新位置,提供可指定新檔案名稱的選項,並覆寫目的地檔案 (如果已存在)。

Open(String, FileMode)

在指定路徑上開啟具有讀取/寫入權限且不共用的 FileStream

Open(String, FileMode, FileAccess)

在指定路徑上開啟具有指定模式和存取權且不共用的 FileStream

Open(String, FileMode, FileAccess, FileShare)

在指定路徑上開啟 FileStream,假定它具有讀取、寫入或讀取/寫入存取的指定模式和指定的共用選項。

Open(String, FileStreamOptions)

使用指定的路徑、建立模式、讀取/寫入和共用許可權,初始化 類別的新實例 FileStream ,其他 FileStreams 可以擁有相同的檔案、緩衝區大小、其他檔案選項和配置大小。

OpenHandle(String, FileMode, FileAccess, FileShare, FileOptions, Int64)

使用指定的路徑、建立模式、讀取/寫入和共用許可權,初始化 類別的新實例 SafeFileHandle ,其他 SafeFileHandles 的存取權可以擁有相同的檔案、其他檔案選項和配置大小。

OpenRead(String)

開啟現有檔案來讀取。

OpenText(String)

開啟現有 UTF-8 編碼的文字檔來讀取。

OpenWrite(String)

開啟現有檔案或建立新檔案,以進行寫入。

ReadAllBytes(String)

開啟二進位檔案,將檔案內容讀入位元組陣列,然後關閉檔案。

ReadAllBytesAsync(String, CancellationToken)

以非同步方式開啟二進位檔案,將檔案內容讀入位元組陣列,然後關閉檔案。

ReadAllLines(String)

開啟文字檔,讀取檔案的所有行,然後關閉檔案。

ReadAllLines(String, Encoding)

開啟檔案,以指定的編碼方式讀取檔案的所有行,然後關閉檔案。

ReadAllLinesAsync(String, CancellationToken)

以非同步方式開啟文字檔,讀取檔案的所有行,然後關閉檔案。

ReadAllLinesAsync(String, Encoding, CancellationToken)

以非同步方式開啟文字檔,以指定的編碼方式讀取檔案所有行,然後關閉檔案。

ReadAllText(String)

開啟文字檔,讀取檔案中的所有文字,然後關閉該檔案。

ReadAllText(String, Encoding)

開啟檔案,利用指定的編碼方式讀取檔案中的所有文字,然後關閉該檔案。

ReadAllTextAsync(String, CancellationToken)

以非同步方式開啟文字檔,讀取檔案中的所有文字,然後關閉該檔案。

ReadAllTextAsync(String, Encoding, CancellationToken)

以非同步方式開啟文字檔,以指定的編碼方式讀取檔案所有文字,然後關閉檔案。

ReadLines(String)

讀取檔案的所有行。

ReadLines(String, Encoding)

讀取具有指定編碼方式的檔案所有行。

Replace(String, String, String)

用另一個檔案的內容取代指定檔案的內容,刪除原始檔案並建立已取代檔案的備份。

Replace(String, String, String, Boolean)

用另一個檔案的內容取代指定檔案的內容,刪除原始檔案,建立已取代檔案的備份,並選擇性地忽略合併錯誤。

ResolveLinkTarget(String, Boolean)

取得指定檔案連結的目標。

SetAccessControl(String, FileSecurity)

FileSecurity 物件描述的存取控制清單 (ACL) 項目套用至指定的檔案。

SetAttributes(String, FileAttributes)

在指定路徑上設定檔案的指定 FileAttributes

SetCreationTime(String, DateTime)

設定檔案建立的日期和時間。

SetCreationTimeUtc(String, DateTime)

設定檔案建立的日期和時間,格式為國際標準時間 (UTC)。

SetLastAccessTime(String, DateTime)

取得指定檔案上一次被存取的日期和時間。

SetLastAccessTimeUtc(String, DateTime)

設定指定檔案上次被存取的日期和時間,格式為國際標準時間 (UTC)。

SetLastWriteTime(String, DateTime)

設定指定檔案上次被寫入的日期和時間。

SetLastWriteTimeUtc(String, DateTime)

設定指定檔案上次寫入的日期和時間,格式為國際標準時間 (UTC)。

WriteAllBytes(String, Byte[])

建立新檔案,將指定的位元組陣列寫入檔案,然後關閉檔案。 如果檔案已經存在,則會覆寫該檔案。

WriteAllBytesAsync(String, Byte[], CancellationToken)

以非同步方式建立新檔案,將指定的位元組陣列寫入檔案,然後關閉檔案。 如果檔案已經存在,則會覆寫該檔案。

WriteAllLines(String, IEnumerable<String>)

建立新檔案,並於檔案中寫入字串的集合,然後關閉檔案。

WriteAllLines(String, IEnumerable<String>, Encoding)

使用指定編碼方式建立新檔案,並將字串的集合寫入檔案,然後關閉檔案。

WriteAllLines(String, String[])

建立新檔案,將指定的字串陣列寫入檔案,然後關閉檔案。

WriteAllLines(String, String[], Encoding)

建立新檔案,使用指定的編碼方式將指定的字串陣列寫入檔案,然後關閉檔案。

WriteAllLinesAsync(String, IEnumerable<String>, CancellationToken)

以非同步方式建立新檔案,將指定的行寫入檔案,然後關閉檔案。

WriteAllLinesAsync(String, IEnumerable<String>, Encoding, CancellationToken)

以非同步方式建立新檔案,使用指定編碼方式將指定的行寫入檔案,然後關閉檔案。

WriteAllText(String, String)

建立新檔案,將指定的字串寫入檔案,然後關閉檔案。 如果檔案已經存在,則會覆寫該檔案。

WriteAllText(String, String, Encoding)

建立新檔案,使用指定的編碼方式將指定的字串寫入檔案,然後關閉檔案。 如果檔案已經存在,則會覆寫該檔案。

WriteAllTextAsync(String, String, CancellationToken)

以非同步方式建立新檔案,將指定的字串寫入檔案,然後關閉檔案。 如果檔案已經存在,則會覆寫該檔案。

WriteAllTextAsync(String, String, Encoding, CancellationToken)

以非同步方式建立新檔案,使用指定編碼方式將指定的字串寫入檔案,然後關閉檔案。 如果檔案已經存在,則會覆寫該檔案。

適用於

另請參閱