OleDbParameterCollection Class

Definition

Namespace:

System.Data.OleDb

Assembly:

System.Data.OleDb.dll

Package:

System.Data.OleDb v9.0.0-rc.2.24473.5

Source:

OleDbParameterCollection.cs

Represents a collection of parameters relevant to an OleDbCommand as well as their respective mappings to columns in a DataSet.

public ref class OleDbParameterCollection sealed : System::Data::Common::DbParameterCollection

public sealed class OleDbParameterCollection : System.Data.Common.DbParameterCollection

type OleDbParameterCollection = class
    inherit DbParameterCollection

Public NotInheritable Class OleDbParameterCollection
Inherits DbParameterCollection

Inheritance

Object

MarshalByRefObject

DbParameterCollection

OleDbParameterCollection

Examples

The following example creates multiple instances of OleDbParameter through the OleDbParameterCollection collection within the OleDbDataAdapter. These parameters are used to select data within the data source and place the data in the DataSet. This example assumes that a DataSet and an OleDbDataAdapter have already been created with the appropriate schema, commands, and connection.

public DataSet GetDataSetFromAdapter(
    DataSet dataSet, string connectionString, string queryString)
{
    using (OleDbConnection connection =
               new OleDbConnection(connectionString))
    {
        OleDbDataAdapter adapter =
            new OleDbDataAdapter(queryString, connection);

        // Set the parameters.
        adapter.SelectCommand.Parameters.Add(
            "@CategoryName", OleDbType.VarChar, 80).Value = "toasters";
        adapter.SelectCommand.Parameters.Add(
            "@SerialNum", OleDbType.Integer).Value = 239;

        // Open the connection and fill the DataSet.
        try
        {
            connection.Open();
            adapter.Fill(dataSet);
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
        // The connection is automatically closed when the
        // code exits the using block.
    }
    return dataSet;
}

Public Function GetDataSetFromAdapter( _
    ByVal dataSet As DataSet, ByVal connectionString As String, _
    ByVal queryString As String) As DataSet

    Using connection As New OleDbConnection(connectionString)
        Dim adapter As New OleDbDataAdapter(queryString, connection)

        ' Set the parameters.
        adapter.SelectCommand.Parameters.Add( _
            "@CategoryName", OleDbType.VarChar, 80).Value = "toasters"
        adapter.SelectCommand.Parameters.Add( _
         "@SerialNum", OleDbType.Integer).Value = 239

        ' Open the connection and fill the DataSet.
        Try
            connection.Open()
            adapter.Fill(dataSet)
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try
        ' The connection is automatically closed when the
        ' code exits the Using block.
    End Using

    Return dataSet
End Function

Remarks

The number of parameters in the collection must equal the number of parameter placeholders within the command text, otherwise the .NET Framework Data Provider for OLE DB might raise an error.

Properties

Count	Returns an integer that contains the number of elements in the OleDbParameterCollection. Read-only.
IsFixedSize	Gets a value that indicates whether the OleDbParameterCollection has a fixed size. Read-only.
IsReadOnly	Gets a value that indicates whether the OleDbParameterCollection is read-only.
IsSynchronized	Gets a value that indicates whether the OleDbParameterCollection is synchronized. Read-only.
Item[Int32]	Gets or sets the OleDbParameter at the specified index.
Item[String]	Gets or sets the OleDbParameter with the specified name.
SyncRoot	Gets an object that can be used to synchronize access to the OleDbParameterCollection. Read-only.

Methods

Add(Object)	Adds the specified OleDbParameter object to the OleDbParameterCollection.
Add(OleDbParameter)	Adds the specified OleDbParameter to the OleDbParameterCollection.
Add(String, Object)	Obsolete. Adds an OleDbParameter to the OleDbParameterCollection given the parameter name and value.
Add(String, OleDbType)	Adds an OleDbParameter to the OleDbParameterCollection, given the parameter name and data type.
Add(String, OleDbType, Int32)	Adds an OleDbParameter to the OleDbParameterCollection given the parameter name, data type, and column length.
Add(String, OleDbType, Int32, String)	Adds an OleDbParameter to the OleDbParameterCollection given the parameter name, data type, column length, and source column name.
AddRange(Array)	Adds an array of values to the end of the OleDbParameterCollection.
AddRange(OleDbParameter[])	Adds an array of OleDbParameter values to the end of the OleDbParameterCollection.
AddWithValue(String, Object)	Adds a value to the end of the OleDbParameterCollection.
Clear()	Removes all OleDbParameter objects from the OleDbParameterCollection.
Contains(Object)	Determines whether the specified Object is in this OleDbParameterCollection.
Contains(OleDbParameter)	Determines whether the specified OleDbParameter is in this OleDbParameterCollection.
Contains(String)	Determines whether the specified String is in this OleDbParameterCollection.
CopyTo(Array, Int32)	Copies all the elements of the current OleDbParameterCollection to the specified one-dimensional Array starting at the specified destination Array index.
CopyTo(OleDbParameter[], Int32)	Copies all the elements of the current OleDbParameterCollection to the specified OleDbParameterCollection starting at the specified destination index.
CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator()	Returns an enumerator that iterates through the OleDbParameterCollection.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Obsolete. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetParameter(Int32)	Returns the DbParameter object at the specified index in the collection. (Inherited from DbParameterCollection)
GetParameter(String)	Returns DbParameter the object with the specified name. (Inherited from DbParameterCollection)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IndexOf(Object)	The location of the specified Object within the collection.
IndexOf(OleDbParameter)	Gets the location of the specified OleDbParameter within the collection.
IndexOf(String)	Gets the location of the specified OleDbParameter with the specified name.
InitializeLifetimeService()	Obsolete. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
Insert(Int32, Object)	Inserts a Object into the OleDbParameterCollection at the specified index.
Insert(Int32, OleDbParameter)	Inserts a OleDbParameter object into the OleDbParameterCollection at the specified index.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
Remove(Object)	Removes the Object object from the OleDbParameterCollection.
Remove(OleDbParameter)	Removes the OleDbParameter from the OleDbParameterCollection.
RemoveAt(Int32)	Removes the OleDbParameter from the OleDbParameterCollection at the specified index.
RemoveAt(String)	Removes the OleDbParameter from the OleDbParameterCollection at the specified parameter name.
SetParameter(Int32, DbParameter)	Sets the DbParameter object at the specified index to a new value. (Inherited from DbParameterCollection)
SetParameter(String, DbParameter)	Sets the DbParameter object with the specified name to a new value. (Inherited from DbParameterCollection)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IDataParameterCollection.Item[String]	Gets or sets the parameter at the specified index. (Inherited from DbParameterCollection)
IList.Add(Object)	For a description of this member, see Add(Object). (Inherited from DbParameterCollection)
IList.Contains(Object)	For a description of this member, see Contains(Object). (Inherited from DbParameterCollection)
IList.IndexOf(Object)	For a description of this member, see IndexOf(Object). (Inherited from DbParameterCollection)
IList.Insert(Int32, Object)	For a description of this member, see Insert(Int32, Object). (Inherited from DbParameterCollection)
IList.Item[Int32]	Gets or sets the element at the specified index. (Inherited from DbParameterCollection)
IList.Remove(Object)	For a description of this member, see Remove(Object). (Inherited from DbParameterCollection)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

See also

• Working with Commands
• Using Parameters with a DataAdapter