Remove メソッド (Collection オブジェクト)
更新 : 2007 年 11 月
Collection オブジェクトから要素を削除します。
Public Overloads Sub Remove(_
ByVal { Key As String | Index As Integer } _
)
パラメータ
Key
コレクションの要素へアクセスするために使用できる、(位置を示すインデックスではなく) キー文字列を指定する一意な String 式です。Key は、コレクションに要素を追加するときに指定した Key 引数と一致している必要があります。Index
コレクションの要素の位置を特定する数式です。Index は 1 からコレクションの Count プロパティ (Collection オブジェクト) までの値であることが必要です。
例外
例外の種類 |
エラー番号 |
条件 |
|---|---|---|
Key が無効であるか、指定されていません。 |
||
Index がコレクションの既存の要素のいずれにも一致しません。 |
非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、"エラー番号" の列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と比較することもできます)。ただし、可能であれば、このようなエラー制御は Visual Basic の構造化例外処理の概要 に置き換えることを検討してください。
解説
Remove はコレクションから要素を削除すると、コレクションの Count プロパティ (Collection オブジェクト) を 1 ずつ減算します。また、削除された要素の後に続くすべての要素の Index 値もデクリメントします。
Key を指定せずにコレクションに追加した要素は、Index を使わなければ削除できません。
使用例
Remove メソッドを使って、変数 birthdays の Collection オブジェクト (Visual Basic) からオブジェクトを削除する例を次に示します。
Dim birthdays As New Collection()
birthdays.Add(New DateTime(2001, 1, 12), "Bill")
birthdays.Add(New DateTime(2001, 1, 13), "Joe")
birthdays.Add(New DateTime(2001, 1, 14), "Mike")
birthdays.Add(New DateTime(2001, 1, 15), "Pete")
...
birthdays.Remove(1)
birthdays.Remove("Mike")
Add メソッドを 4 回呼び出した後、Count プロパティには 4 が格納され、要素 "Bill" のインデックスの値は 1、また要素 "Pete" のインデックスの値は 4 になります。
最初に Remove を呼び出した後、Count は 3 になり、要素 "Bill" が削除され、要素 "Pete" のインデックスの値は 3 になります。
2 度目の Remove 呼び出しの後、Count は 2 になり、要素 "Mike" が削除され、要素 "Pete" のインデックスの値は 2 になります。
必要条件
名前空間 : Microsoft.VisualBasic
モジュール : Collection
アセンブリ : Visual Basic ランタイム ライブラリ (Microsoft.VisualBasic.dll)