ConfigurationElement.LockItem プロパティ

.NET Framework クラス ライブラリ リファレンス

ConfigurationElement.LockItem プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

要素がロックされているかどうかを示す値を取得または設定します。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Visual Basic (宣言)

Public Property LockItem As
 Boolean

Visual Basic (使用法)

Dim instance As ConfigurationElement
Dim value As Boolean

value = instance.LockItem

instance.LockItem = value

C#

public bool LockItem { get;
 set; }

C++

public:
property bool LockItem {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_LockItem ()

/** @property */
public void set_LockItem (boolean value)

JScript

public function get LockItem
 () : boolean

public function set LockItem
 (value : boolean)

プロパティ値
要素がロックされている場合は true。それ以外の場合は false。既定値は false です。

解説

要素自体およびその子要素に対して汎用的なロックを実行する場合は、LockItem プロパティを使用します。

使用例

LockItem を使用する方法の例を次に示します。

Visual Basic

' 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

C#

// Show how to set LockItem
// It adds a new UrlConfigElement to 
// the collection.
static void LockItem()
{
    string name = "Contoso";
    string url = "http://www.contoso.com/";
    int port = 8080;

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

        // Get the MyUrls section.
        UrlsSection myUrls =
           config.Sections["MyUrls"] as UrlsSection;


        // Create the new  element.
        UrlConfigElement newElement =
            new UrlConfigElement(name, url, port);

        // Set its lock.
        newElement.LockItem = true;

        // Save the new element to the 
        // configuration file.
        if (!myUrls.ElementInformation.IsLocked)
        {

            myUrls.Urls.Add(newElement);

            config.Save(ConfigurationSaveMode.Full);

            // This is used to obsolete the cached 
            // section and read the updated 
            // bersion from the configuration file.
            ConfigurationManager.RefreshSection("MyUrls");
        }
        else
            Console.WriteLine(
                "Section was locked, could not update.");

    }
    catch (ConfigurationErrorsException e)
    {
        Console.WriteLine("[LockItem: {0}]",
            e.ToString());
    }

}

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConfigurationElement クラス
ConfigurationElement メンバ
System.Configuration 名前空間