SectionInformation.IsLocked Property

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Package:

System.Configuration.ConfigurationManager v8.0.0

Source:

SectionInformation.cs

Gets a value that indicates whether the associated configuration section is locked.

public:
 property bool IsLocked { bool get(); };

public bool IsLocked { get; }

member this.IsLocked : bool

Public ReadOnly Property IsLocked As Boolean

Property Value

Boolean

true if the section is locked; otherwise, false.

Examples

The examples in this section show how to get the IsLocked property value after accessing the related section information in the configuration file.

The following example gets the SectionInformation object.

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

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

SectionInformation sInfo =
    section.SectionInformation;

' 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)
        
Dim sInfo As SectionInformation = _
section.SectionInformation

The following example gets the IsLocked value.

bool locked =
   sInfo.IsLocked;
Console.WriteLine("Section locked?: {0}",
    locked.ToString());

Dim locked As Boolean = _
sInfo.IsLocked
Console.WriteLine("Section locked?: {0}", _
locked.ToString())

Remarks

The IsLocked property returns true when the related section is locked by the AllowOverride or the AllowDefinition property. A section is locked if it cannot be overridden or defined in the current configuration file.