ObjectParameterCollection.Remove(ObjectParameter) メソッド

定義

名前空間:

System.Data.Objects

アセンブリ:

System.Data.Entity.dll

参照によって、ObjectParameter のインスタンスをコレクションから削除します (コレクション内に存在する場合)。

public:
 virtual bool Remove(System::Data::Objects::ObjectParameter ^ parameter);

public bool Remove (System.Data.Objects.ObjectParameter parameter);

abstract member Remove : System.Data.Objects.ObjectParameter -> bool
override this.Remove : System.Data.Objects.ObjectParameter -> bool

Public Function Remove (parameter As ObjectParameter) As Boolean

パラメーター

parameter

ObjectParameter

コレクションから削除するオブジェクト。

戻り値

Boolean

パラメーター オブジェクトが見つかり、コレクションから削除された場合は true。それ以外の場合は false。

実装

Remove(T)

例外

ArgumentNullException

parameter 引数が null です。

例

次の使用例は、コレクションに 2 つのパラメーターを追加し、パラメーターを削除します。

using (AdventureWorksEntities context =
    new AdventureWorksEntities())
{
    string queryString =
        @"SELECT VALUE contact FROM AdventureWorksEntities.Contacts
        AS contact WHERE contact.LastName = @ln AND contact.FirstName = @fn";

    ObjectQuery<Contact> contactQuery =
        new ObjectQuery<Contact>(queryString, context);

    // Add parameters to the ObjectQuery's Parameters collection.
    contactQuery.Parameters.Add(new ObjectParameter("ln", "Adams"));
    contactQuery.Parameters.Add(new ObjectParameter("fn", "Frances"));

    ObjectParameterCollection objectParameterCollection =
        contactQuery.Parameters;
    Console.WriteLine("Count before Remove is called: {0}",
        objectParameterCollection.Count);

    ObjectParameter objectParameter = objectParameterCollection["ln"];

    // Remove the specified parameter from the collection.
    objectParameterCollection.Remove(objectParameter);
    Console.WriteLine("Count after Remove is called: {0}",
        objectParameterCollection.Count);
}

注釈

これは参照に基づく比較です。 つまり、コレクション内のパラメーター オブジェクトと同じ名前を含むクエリ パラメーター オブジェクトが指定された場合に、同じオブジェクトであるときだけ、コレクション内のパラメーターが削除されます。 オブジェクトを名前によって削除するには、まずインデクサーを使用してパラメーター インスタンスを取得し、次にこのメソッドを使用して削除します。