ConfigurationPropertyCollection.Remove メソッド

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

ConfigurationPropertyCollection.Remove メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

構成プロパティをコレクションから削除します。

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

Visual Basic (宣言)

Public Function Remove ( _
    name As String _
) As Boolean

Visual Basic (使用法)

Dim instance As ConfigurationPropertyCollection
Dim name As String
Dim returnValue As Boolean

returnValue = instance.Remove(name)

C#

public bool Remove (
    string name
)

C++

public:
bool Remove (
    String^ name
)

J#

public boolean Remove (
    String name
)

JScript

public function Remove (
    name : String
) : boolean

パラメータ

name

削除する ConfigurationProperty。

戻り値
指定した ConfigurationProperty が削除された場合は true。それ以外の場合は false。

解説

戻り値が false のときは、指定した ConfigurationProperty オブジェクトがコレクションに格納されていなかったことを示します。

使用例

Remove メソッドを使用する方法の例を次に示します。

Visual Basic

' Remove an element from the property collection.
' It deletes the specified attribute from the
' configuration element represented by
' the property.
Public Sub RemoveCollectionElement(elName As
 String)
   Properties.Remove(elName)
End Sub 'RemoveCollectionElement

C#

// Remove an element from the property collection.
// It deletes the specified attribute from the
// configuration element represented by
// the property.
public void RemoveCollectionElement(string
 elName)
{
    Properties.Remove(elName);
}

上記のメソッドを呼び出して、構成ファイルに変更を保存する方法の例を次に示します。

Visual Basic

' Remove a collection of element.
Shared Sub RemoveCollectionElement()
   Try
      
      Dim customSection As CustomSection
      
         ' Get the current configuration file.
         Dim config As System.Configuration.Configuration
 = _
         ConfigurationManager.OpenExeConfiguration( _
         ConfigurationUserLevel.None)

         ' Get the custom section.
         customSection = _
         config.GetSection("CustomSection")

         'Remove the alias property.
         customSection.RemoveCollectionElement("alias")
      
      If Not customSection.IsReadOnly() Then
         customSection.SectionInformation.ForceSave = True
         config.Save(ConfigurationSaveMode.Full)
      End If
   
   Catch err As ConfigurationErrorsException
      Console.WriteLine(err.ToString())
   End Try
End Sub 'RemoveCollectionElement
 

C#

// Remove a collection of element.
static void RemoveCollectionElement()
{
    try
    {

        CustomSection customSection;

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

        customSection = 
            config.GetSection("CustomSection") as CustomSection;
        customSection.RemoveCollectionElement("alias");

        if (!customSection.IsReadOnly())
        {
            customSection.SectionInformation.ForceSave = true;
            config.Save(ConfigurationSaveMode.Full);
        }
        
    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine(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

参照

関連項目
ConfigurationPropertyCollection クラス
ConfigurationPropertyCollection メンバ
System.Configuration 名前空間
ConfigurationProperty クラス
ConfigurationSection
ElementInformation
ConfigurationElementCollection クラス
ConfigurationElementCollectionType 列挙体
ConfigurationElement クラス
ConfigurationSection