Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ConfigurationElement.LockItem Property

Gets or sets a value indicating whether the element is locked.

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
'Declaration
Public Property LockItem As Boolean
'Usage
Dim instance As ConfigurationElement 
Dim value As Boolean 

value = instance.LockItem

instance.LockItem = value

Property Value

Type: System.Boolean
true if the element is locked; otherwise, false. The default is false.
ExceptionCondition
ConfigurationErrorsException

The element has already been locked at a higher configuration level.

Use the LockItem property if you want to put a general lock on the element itself and its child elements.

The following example shows how to use the LockItem.

' Show how to set LockItem 
' It adds a new UrlConfigElement to  
' the collection. 
Shared Sub LockItem()
    Dim name As String = "Contoso" 
    Dim url As String = "http://www.contoso.com/" 
    Dim port As Integer = 8080

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

        ' Get the MyUrls section. 
        Dim myUrls As UrlsSection = _
        config.Sections("MyUrls")


        ' Create the new  element. 
        Dim newElement _
        As New UrlConfigElement(name, url, port)

        ' Set its lock.
        newElement.LockItem = True 

        ' Save the new element to the  
        ' configuration file. 
        If Not myUrls.ElementInformation.IsLocked Then

            myUrls.Urls.Add(newElement)

            config.Save(ConfigurationSaveMode.Full)

            ' This is used to obsolete the cached  
            ' section and read the updared version  
            ' from the configuration file.
            ConfigurationManager.RefreshSection("MyUrls")
        Else
            Console.WriteLine("Section was locked, could not update.")
        End If 

    Catch e As ConfigurationErrorsException
        Console.WriteLine("[LockItem: {0}]", _
        e.ToString())
    End Try 

End Sub 'LockItem

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.