ObjectParameterCollection.Remove(ObjectParameter) ObjectParameterCollection.Remove(ObjectParameter) ObjectParameterCollection.Remove(ObjectParameter) ObjectParameterCollection.Remove(ObjectParameter) Method

定義

参照によって、ObjectParameter のインスタンスをコレクションから削除します (コレクション内に存在する場合)。Removes an instance of an ObjectParameter from the collection by reference if it exists in the collection.

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 ObjectParameter ObjectParameter ObjectParameter

コレクションから削除するオブジェクト。An object to remove from the collection.

戻り値

パラメーター オブジェクトが見つかり、コレクションから削除された場合は true。それ以外の場合は falsetrue if the parameter object was found and removed from the collection; otherwise, false.

実装

例外

parameter 引数が null です。The parameter argument is null.

このトピックの例は、 AdventureWorks Sales Modelに基づいています。The example in this topic is based on the AdventureWorks Sales Model. この例では、2 つのパラメーターをコレクションに追加し、それらのパラメーターを削除します。The example adds two parameters to the collection and then removes the parameters.

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);
}
Using context As New AdventureWorksEntities()
    Dim queryString As String = "SELECT VALUE contact FROM AdventureWorksEntities.Contacts " & _
            " AS contact WHERE contact.LastName = @ln AND contact.FirstName = @fn"

    Dim contactQuery As New ObjectQuery(Of 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"))

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

    Dim objectParameter As ObjectParameter = objectParameterCollection("ln")

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

注釈

これは参照に基づく比較です。This is a reference-based comparison. つまり、コレクション内のパラメーター オブジェクトと同じ名前を含むクエリ パラメーター オブジェクトが指定された場合に、同じオブジェクトであるときだけ、コレクション内のパラメーターが削除されます。That is, if a query parameter object is specified that contains the same name as a parameter object in the collection, the parameter in the collection will only be removed if it is the same object. オブジェクトを名前によって削除するには、まずインデクサーを使用してパラメーター インスタンスを取得し、次にこのメソッドを使用して削除します。To remove an object by name, first use the indexer to retrieve the parameter instance, then remove it by using this method.

適用対象