DB2ParameterCollection.Remove Method

Removes the specified DB2Parameter from the collection.

Namespace:: IBM.Data.DB2
Assembly:: IBM.Data.DB2 (in IBM.Data.DB2.dll)

Syntax


[Visual Basic]
NotOverridable Public Sub Remove( _
   ByVal value As Object _
)
[C#]
public void Remove(
   object value
);
[C++]
public: __sealed void Remove(
   Object* value
);
[JScript]
public function Remove(
   value : Object
);

Parameters

value: The DB2®Parameter object to remove from the collection.

Exceptions

Exception type	Condition
ArgumentException	The parameter does not exist.
InvalidCastException	The parameter is not a valid DB2Parameter .

Example

[Visual Basic, C#] The following example searches for a DB2Parameter object in a DB2ParameterCollection . If the parameter exists, it is removed. This example assumes that a DB2ParameterCollection has already been created.

[Visual Basic]
Public Sub SearchDB2Params()
    ' ...
    ' create DB2ParameterCollection myParameters and DB2Parameter myNewParam
    ' ...
    If myParameters.Contains(CType(myNewParam, Object)) Then
        myParameters.Remove(CType(myNewParam, Object))
    End If
End Sub 'SearchDB2Params

[C#]
public void SearchDB2Params() {
    // ...
    // create DB2ParameterCollection myParameters and DB2Parameter myNewParam
    // ...
    if (myParameters.Contains((Object) myNewParam))
       myParameters.Remove(((Object) myNewParam));
 }