File.Encrypt(String) 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

來源:

File.cs

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

public:
 static void Encrypt(System::String ^ path);

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static void Encrypt (string path);

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member Encrypt : string -> unit

Public Shared Sub Encrypt (path As String)

參數

path

String

路徑，描述要加密的檔案。

屬性

SupportedOSPlatformAttribute

例外狀況

ArgumentException

.NET Framework 和 2.1 之前的 .NET Core 版本：參數path是長度為零的字串、只包含空格符，或包含一或多個無效的字元。 您可以使用 GetInvalidPathChars() 方法查詢無效字元。

ArgumentNullException

path 參數為 null。

DriveNotFoundException

指定的磁碟機無效。

FileNotFoundException

找不到 path 參數所描述的檔案。

IOException

開啟檔案時發生 I/O 錯誤。

-或-

這個作業在目前平台不受支援。

PathTooLongException

指定的路徑、檔案名稱，或兩者都超出系統定義的長度上限。

PlatformNotSupportedException

目前的作業系統不是 Windows NT 或更新版本。

NotSupportedException

檔案系統不是 NTFS。

UnauthorizedAccessException

path 參數指定了唯讀的檔案。

-或-

這個作業在目前平台不受支援。

-或-

path 參數指定了目錄。

-或-

呼叫端沒有必要的權限。

範例

下列程式代碼範例會使用 Encrypt 方法和 Decrypt 方法來加密和解密檔案。 檔案必須存在，範例才能運作。

using namespace System;
using namespace System::IO;

int main()
{
    String^ fileName = "test.xml";
    if (!File::Exists(fileName))
    {
        Console::WriteLine("The file " + fileName
            + " does not exist.");
        return 0;
    }
    try
    {
        Console::WriteLine("Encrypt " + fileName);

        // Encrypt the file.
        File::Encrypt(fileName);

        Console::WriteLine("Decrypt " + fileName);

        // Decrypt the file.
        File::Decrypt(fileName);

        Console::WriteLine("Done");
    }
    catch (IOException^ ex)
    {
        Console::WriteLine("There was an IO problem.");
        Console::WriteLine(ex->Message);
    }
    catch (PlatformNotSupportedException^)
    {
        Console::WriteLine("Encryption is not supported on " +
            "this system.");
    }
    catch (NotSupportedException^)
    {
        Console::WriteLine("Encryption is not supported on " +
            "this system.");
    }
    catch (UnauthorizedAccessException^)
    {
        Console::WriteLine("The operation could not be "
            + "carried out.");
    }
}

using System;
using System.IO;
using System.Security.AccessControl;

namespace FileSystemExample
{
    class FileExample
    {
        public static void Main()
        {
            try
            {
                string FileName = "test.xml";

                Console.WriteLine("Encrypt " + FileName);

                // Encrypt the file.
                AddEncryption(FileName);

                Console.WriteLine("Decrypt " + FileName);

                // Decrypt the file.
                RemoveEncryption(FileName);

                Console.WriteLine("Done");
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }

            Console.ReadLine();
        }

        // Encrypt a file.
        public static void AddEncryption(string FileName)
        {

            File.Encrypt(FileName);
        }

        // Decrypt a file.
        public static void RemoveEncryption(string FileName)
        {
            File.Decrypt(FileName);
        }
    }
}

open System.IO

// Encrypt a file.
let addEncryption fileName = File.Encrypt fileName

// Decrypt a file.
let removeEncryption fileName = File.Decrypt fileName

let fileName = "test.xml"

printfn $"Encrypt {fileName}"

// Encrypt the file.
addEncryption fileName

printfn $"Decrypt {fileName}"

// Decrypt the file.
removeEncryption fileName

printfn "Done"

Imports System.IO
Imports System.Security.AccessControl



Module FileExample

    Sub Main()
        Try
            Dim FileName As String = "test.xml"

            Console.WriteLine("Encrypt " + FileName)

            ' Encrypt the file.
            AddEncryption(FileName)

            Console.WriteLine("Decrypt " + FileName)

            ' Decrypt the file.
            RemoveEncryption(FileName)

            Console.WriteLine("Done")
        Catch e As Exception
            Console.WriteLine(e)
        End Try

        Console.ReadLine()

    End Sub


    ' Encrypt a file.
    Sub AddEncryption(ByVal FileName As String)

        File.Encrypt(FileName)

    End Sub


    ' Decrypt the file.
    Sub RemoveEncryption(ByVal FileName As String)

        File.Decrypt(FileName)

    End Sub
End Module

備註

方法 Encrypt 可讓您加密檔案，以便只有用來呼叫此方法的帳戶可以解密它。 Decrypt使用方法來解密 方法所加密的Encrypt檔案。

重要

只有能夠使用NTFS加密文件系統 (EFS) 的 Windows 平臺才支援此 API。 任何嘗試在非 Windows 系統、Windows Home Edition 系統或非 NTFS 磁碟驅動器上使用，都 PlatformNotSupportedException 會導致 或 NotSupportedException，視情況而定。

不建議在 .NET Core 中使用此 API;它包含在內，可針對移至 .NET Core 但仍明確以 Windows 為目標的應用程式啟用可移植性。

方法 Encrypt 需要對正在加密的檔案進行獨佔存取，如果另一個進程正在使用檔案，將會失敗。

Encrypt方法與 Decrypt 方法都會使用安裝在計算機上的密碼編譯服務提供者 (CSP) ，以及呼叫 方法的程式檔案加密密鑰。

此方法不適用於所有版本的 Windows。 例如，它不適用於 Home 版本。

目前的檔案系統必須格式化為NTFS。