Expand
SectionInformation.ProtectSection Method

Marks a configuration section for protection.

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
Syntax

'Declaration

Public Sub ProtectSection ( _
	protectionProvider As String _
)

Parameters

protectionProvider
Type: System.String
The name of the protection provider to use.
Exceptions

ExceptionCondition
InvalidOperationException

The AllowLocation property is set to false.

- or -

The target section is already a protected data section.

Remarks

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:

DPAPIProtectedConfigurationProvider

RSAProtectedConfigurationProvider

NoteNote

If you call the ProtectSection method with a Nothing parameter or an empty string, the RSAProtectedConfigurationProvider class is used as the protection provider.

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

Examples

The following example shows how to use the ProtectSection method.


Public Shared Sub ProtectSection() 

    ' Get the current configuration file.
    Dim config _
    As System.Configuration.Configuration = _
    ConfigurationManager.OpenExeConfiguration( _
    ConfigurationUserLevel.None)


    ' Get the section.
    Dim section As UrlsSection = _
    CType(config.GetSection("MyUrls"), UrlsSection)


    ' 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.
    Dim sectionXml As String = _
    section.SectionInformation.GetRawXml()

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

End Sub 'ProtectSection
 


Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role not supported), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
See Also

Reference

DPAPIProtectedConfigurationProvider
RSAProtectedConfigurationProvider

Other Resources

Community ContentAdd
Page view tracker