SectionInformation.ProtectSection Method

Marks a configuration section for protection.

Namespace: System.Configuration
Assembly: System.Configuration (in system.configuration.dll)

public void ProtectSection (
	string protectionProvider
)
public void ProtectSection (
	String protectionProvider
)
public function ProtectSection (
	protectionProvider : String
)
Not applicable.

Parameters

protectionProvider

The name of the protection provider to use.

Exception typeCondition

InvalidOperationException

The AllowLocation property is set to false.

- or -

The target section is already a protected data section.

The ProtectSection method marks the section for encryption so it will be written in encrypted form on disk.

The following protection providers are included by default:

For more information about protected configuration sections, see Encrypting Configuration Information Using Protected Configuration.

The following example shows how to use the ProtectSection method.

static public void ProtectSection()
{

    // Get the current configuration file.
    System.Configuration.Configuration config =
            ConfigurationManager.OpenExeConfiguration(
            ConfigurationUserLevel.None);


    // Get the section.
    UrlsSection section =
        (UrlsSection)config.GetSection("MyUrls");


    // Protect (encrypt)the section.
    section.SectionInformation.ProtectSection(
        "RsaProtectedConfigurationProvider");

    // Save the encrypted section.
    section.SectionInformation.ForceSave = true;

    config.Save(ConfigurationSaveMode.Full);

    // Display decrypted configuration 
    // section. Note, the system
    // uses the Rsa provider to decrypt
    // the section transparently.
    string sectionXml =
        section.SectionInformation.GetRawXml();

    Console.WriteLine("Decrypted section:");
    Console.WriteLine(sectionXml);

}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: