ConfigurationElement.LockElements プロパティ

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

ConfigurationElement.LockElements プロパティ

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

ロックされている要素のコレクションを取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 LockElements As ConfigurationLockCollection

Visual Basic (使用法)

Dim instance As ConfigurationElement
Dim value As ConfigurationLockCollection

value = instance.LockElements

C#

public ConfigurationLockCollection LockElements { get;
 }

C++

public:
property ConfigurationLockCollection^ LockElements {
    ConfigurationLockCollection^ get ();
}

J#

/** @property */
public ConfigurationLockCollection get_LockElements ()

JScript

public function get LockElements
 () : ConfigurationLockCollection

プロパティ値
ロックされている要素の ConfigurationLockCollection。

解説

LockElements を使用すると、指定したすべての要素をロックできます。

これを行うには、次の例に示すように、Contains メソッドを使用します。

メモ
LockElements プロパティを使用すると、規則の適用先要素の子構成要素が変更されないようにできます。要素自体およびその子要素に対して汎用的なロックを実行する場合は、LockItem を使用します。

使用例

LockElements プロパティを使用する方法の例を次に示します。

Visual Basic

' Show how to use LockElements
' It locks and unlocks the urls element.
Shared Sub LockElements() 
    
    Try
        ' Get the current configuration file.
        Dim config _
        As System.Configuration.Configuration = _
        ConfigurationManager.OpenExeConfiguration( _
        ConfigurationUserLevel.None)

        ' Get the MyUrls section.
        Dim myUrlsSection As UrlsSection =
 _
        config.GetSection("MyUrls")
        
        If myUrlsSection Is Nothing
 Then
            Console.WriteLine("Failed to load UrlsSection.")
        Else
            ' Get MyUrls section LockElements collection.
            Dim lockElements _
            As ConfigurationLockCollection = _
            myUrlsSection.LockElements
            
            ' Get MyUrls section LockElements collection 
            ' enumerator.
            Dim lockElementEnum As IEnumerator
 = _
            lockElements.GetEnumerator()
            
            ' Position the collection index.
            lockElementEnum.MoveNext()
            
            If lockElements.Contains("urls")
 Then
                ' Remove the lock on the urls element.
                lockElements.Remove("urls")
            Else
                ' Add the lock on the urls element.
                lockElements.Add("urls")
            End If 
            ' Save the change.
            config.Save(ConfigurationSaveMode.Full)
        End If 
    
    Catch err As ConfigurationErrorsException
        Console.WriteLine("[LockElements: {0}]", _
        err.ToString())
    End Try

End Sub 'LockElements

C#

// Show how to use LockElements
// It locks and unlocks the urls element.
static void LockElements()
{

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

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

        if (myUrlsSection == null)
            Console.WriteLine("Failed to load UrlsSection.");
        else
        {
            // Get MyUrls section LockElements collection.
            ConfigurationLockCollection lockElements =
                myUrlsSection.LockElements;

            // Get MyUrls section LockElements collection 
            // enumerator.
            IEnumerator lockElementEnum =
                 lockElements.GetEnumerator();

            // Position the collection index.
            lockElementEnum.MoveNext();

            if (lockElements.Contains("urls"))
                // Remove the lock on the urls element.
                lockElements.Remove("urls");
            else
                // Add the lock on the urls element.
                lockElements.Add("urls");

            // Save the change.
            config.Save(ConfigurationSaveMode.Full);

        }

    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine("[LockElements: {0}]",
            err.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 名前空間
ConfigurationLockCollection