File.Encrypt(String) 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

Source:

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 方法加密的文件。

重要

此 API 仅在能够使用 NTFS 加密文件系统 (EFS) 的 Windows 平台上受支持。 任何尝试在非 Windows 系统、Windows 家庭版系统或非 NTFS 驱动器上使用此功能都会导致 PlatformNotSupportedException 或 NotSupportedException，具体取决于具体情况。

不建议在 .NET Core 中使用此 API;它是为了为迁移到 .NET Core 但仍显式面向 Windows 的应用程序启用可移植性。

方法 Encrypt 需要对正在加密的文件进行独占访问，如果另一个进程正在使用该文件，该方法将失败。

Encrypt方法和 Decrypt 方法都使用安装在计算机上的加密服务提供程序 (CSP) ，以及调用方法的进程的文件加密密钥。

此方法并非在所有版本的 Windows 上都可用。 例如，它在家庭版上不可用。

当前文件系统的格式必须为 NTFS。