ClientTargetCollection.Clear メソッド

定義

コレクションからすべての ClientTarget オブジェクトを削除します。

public:
 void Clear();
public void Clear();
member this.Clear : unit -> unit
Public Sub Clear ()

次のコード例では、ClientTarget コレクションからすべてのClientTargetCollection オブジェクトを削除します。

コレクションを取得する方法については、 ClientTargetCollection クラスの概要のコード例を参照してください。


           // Clear the client target collection.
           clientTargets.Clear();

           // Update the configuration file.
           if (!clientTargetSection.IsReadOnly())
             configuration.Save();
' Clear the client target collection.
clientTargets.Clear()

' Update the configuration file.
If Not clientTargetSection.IsReadOnly() Then
    configuration.Save()
End If

注釈

Clear メソッドの呼び出し後に構成ファイルを更新した結果は、選択したConfigurationSaveMode値に依存します。 構成ファイルを更新するには、 Configuration.Save または Configuration.Saveの 2 つの方法のいずれかを使用します。

Note

Configuration.Saveの呼び出しは、Save値が変更されたときにConfigurationSaveModeを呼び出すことと同じです。

Configuration.Saveメソッドを使用する場合は、次の条件が適用されます。

  • FullまたはModifiedパラメーター値を渡すと、現在の階層レベルの構成ファイルのclear セクションにclientTarget要素が挿入されます。

  • Minimalパラメーター値を渡すと、一連のremove要素が、現在の階層レベルの構成ファイルのclientTarget セクションに追加されます。 これにより、階層内の上位レベルの親構成ファイルで定義されている add 要素への参照がすべて削除されます。 Minimal列挙値を使用すると、コレクションの 1 つの追加プロパティが構成ファイルにシリアル化される内容に影響します。 プロパティは EmitClear され、既定で false されます。 次のいずれかの条件が適用されます。

    • EmitCleartrue に設定すると、現在の階層レベルの構成ファイルの clear セクションにclientTarget要素が挿入されます。 これにより、階層内の上位レベルの親構成ファイルで定義されている add 要素への参照がすべて削除されます。

    • EmitClearfalseに設定されている場合、clear要素が存在する場合は、現在の階層レベルの構成ファイルのclientTarget セクションから削除されます。

Clearメソッドは、現在の階層レベルで構成ファイルのadd セクションで定義されているclientTarget要素を実際に削除します。 また、階層内の上位レベルの親構成ファイルで定義されている add 要素への参照もすべて削除されます。

Note

add要素は、親構成ファイルの clientTarget セクションから削除されません。

適用対象

こちらもご覧ください