ProtectedMemory.Unprotect(Byte[], MemoryProtectionScope) Method

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Security.dll

Unprotects data in memory that was protected using the Protect(Byte[], MemoryProtectionScope) method.

public:
 static void Unprotect(cli::array <System::Byte> ^ encryptedData, System::Security::Cryptography::MemoryProtectionScope scope);

public static void Unprotect (byte[] encryptedData, System.Security.Cryptography.MemoryProtectionScope scope);

static member Unprotect : byte[] * System.Security.Cryptography.MemoryProtectionScope -> unit

Public Shared Sub Unprotect (encryptedData As Byte(), scope As MemoryProtectionScope)

Parameters

encryptedData

Byte[]

The byte array in memory to unencrypt.

scope

MemoryProtectionScope

One of the enumeration values that specifies the scope of memory protection.

Exceptions

NotSupportedException

The operating system does not support this method. This method can be used only with the Windows 2000 or later operating systems.

ArgumentNullException

encryptedData is null.

CryptographicException

encryptedData is empty.

-or-

This call was not implemented.

-or-

NTSTATUS contains an error.

Examples

The following example shows how to use data protection.

#using <System.Security.dll>

using namespace System;
using namespace System::Security::Cryptography;

int main()
{
   
   // Create the original data to be encrypted (The data length should be a multiple of 16).
   array<Byte>^secret = {1,2,3,4,1,2,3,4,1,2,3,4,1,2,3,4};
   
   // Encrypt the data in memory. The result is stored in the same array as the original data.
   ProtectedMemory::Protect( secret, MemoryProtectionScope::SameLogon );
   
   // Decrypt the data in memory and store in the original array.
   ProtectedMemory::Unprotect( secret, MemoryProtectionScope::SameLogon );
}

using System;
using System.Security.Cryptography;

public class MemoryProtectionSample
{

    public static void Main()
    {
        // Create the original data to be encrypted (The data length should be a multiple of 16).
        byte [] secret = { 1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4 };

        // Encrypt the data in memory. The result is stored in the same array as the original data.
        ProtectedMemory.Protect( secret, MemoryProtectionScope.SameLogon );

        // Decrypt the data in memory and store in the original array.
        ProtectedMemory.Unprotect( secret, MemoryProtectionScope.SameLogon );
    }
}

Imports System.Security.Cryptography

Public Class MemoryProtectionSample

    Public Shared Sub Main()
        ' Create the original data to be encrypted (The data length should be a multiple of 16).
        Dim secret As Byte() = {1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4}

        ' Encrypt the data in memory. The result is stored in the same array as the original data.
        ProtectedMemory.Protect(secret, MemoryProtectionScope.SameLogon)

        ' Decrypt the data in memory and store in the original array.
        ProtectedMemory.Unprotect(secret, MemoryProtectionScope.SameLogon)

    End Sub
End Class

Remarks

This method can be used to unencrypt data in memory that was encrypted using the Protect method.

Support for this method is available in the Windows XP and later operating systems.