Contains メソッド (Collection オブジェクト)

[アーティクル]
09/30/2008

更新 : 2007 年 11 月

指定されたキーを持つ要素が Visual Basic Collection オブジェクトに含まれるかどうかを示すブール値 (Boolean) を返します。

Public Function Contains( _
    ByVal Key As String _
) As Boolean

パラメータ

Key
必ず指定します。コレクションから要素を検索するためのキーを指定する String 式です。

例外/エラーコード

例外の種類	エラー番号	条件
ArgumentException	5	指定された Key が Nothing です。

非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、"エラー番号" の列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と比較することもできます)。ただし、可能であれば、このようなエラー制御は Visual Basic の構造化例外処理の概要に置き換えることを検討してください。

解説

Contains は、コレクションに Key とまったく同じキーを持つ要素が含まれている場合に True を返します。それ以外の場合、Contains は False を返します。

Visual Basic Collection に格納される要素には、キーを持つものと持たないものがあります。これは、Add メソッド (Collection オブジェクト) を呼び出すとき、オプションの Key パラメータに引数が指定されたかどうかによって決まります。

使用例

Dim customers As New Microsoft.VisualBasic.Collection()
Dim accountNumber As String = "1234"
' Insert code that obtains new customer objects.
' Use the new customer's account number as the key.
customers.Add(newCustomer, accountNumber)
' The preceding statements can be repeated for several customers.
Dim searchNumber As String = "1234"
' Insert code to obtain an account number to search for.
If customers.Contains(searchNumber) Then
    MsgBox("The desired customer is in the collection.")
Else
    MsgBox("The desired customer is not in the collection.")
End If

コレクションの要素を、キーを使って検索するのであれば、Add メソッドを呼び出すとき必ず引数 Key を指定することを忘れないでください。