0 out of 2 rated this helpful - Rate this topic

OleDbParameterCollection Class

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

System.Object
  System.MarshalByRefObject
    System.Data.Common.DbParameterCollection
      System.Data.OleDb.OleDbParameterCollection

Namespace:  System.Data.OleDb
Assembly:  System.Data (in System.Data.dll)
[ListBindableAttribute(false)]
public sealed class OleDbParameterCollection : DbParameterCollection

The OleDbParameterCollection type exposes the following members.

  Name Description
Public property Count Returns an integer that contains the number of elements in the OleDbParameterCollection. Read-only. (Overrides DbParameterCollection.Count.)
Public property IsFixedSize Gets a value that indicates whether the OleDbParameterCollection has a fixed size. Read-only. (Overrides DbParameterCollection.IsFixedSize.)
Public property IsReadOnly Gets a value that indicates whether the OleDbParameterCollection is read-only. (Overrides DbParameterCollection.IsReadOnly.)
Public property IsSynchronized Gets a value that indicates whether the OleDbParameterCollection is synchronized. Read-only. (Overrides DbParameterCollection.IsSynchronized.)
Public property Item[Int32] Gets or sets the OleDbParameter at the specified index.
Public property Item[String] Gets or sets the OleDbParameter with the specified name.
Public property SyncRoot Gets an object that can be used to synchronize access to the OleDbParameterCollection. Read-only. (Overrides DbParameterCollection.SyncRoot.)
Top
  Name Description
Public method Add(Object) Adds the specified OleDbParameter object to the OleDbParameterCollection. (Overrides DbParameterCollection.Add(Object).)
Public method Add(OleDbParameter) Adds the specified OleDbParameter to the OleDbParameterCollection.
Public method Add(String, OleDbType) Adds an OleDbParameter to the OleDbParameterCollection, given the parameter name and data type.
Public method Add(String, Object) Obsolete. Adds an OleDbParameter to the OleDbParameterCollection given the parameter name and value.
Public method Add(String, OleDbType, Int32) Adds an OleDbParameter to the OleDbParameterCollection given the parameter name, data type, and column length.
Public method Add(String, OleDbType, Int32, String) Adds an OleDbParameter to the OleDbParameterCollection given the parameter name, data type, column length, and source column name.
Public method AddRange(Array) Adds an array of values to the end of the OleDbParameterCollection. (Overrides DbParameterCollection.AddRange(Array).)
Public method AddRange(OleDbParameter[]) Adds an array of OleDbParameter values to the end of the OleDbParameterCollection.
Public method AddWithValue Adds a value to the end of the OleDbParameterCollection.
Public method Clear Removes all OleDbParameter objects from the OleDbParameterCollection. (Overrides DbParameterCollection.Clear().)
Public method Contains(Object) Determines whether the specified Object is in this OleDbParameterCollection. (Overrides DbParameterCollection.Contains(Object).)
Public method Contains(OleDbParameter) Determines whether the specified OleDbParameter is in this OleDbParameterCollection.
Public method Contains(String) Determines whether the specified String is in this OleDbParameterCollection. (Overrides DbParameterCollection.Contains(String).)
Public method CopyTo(Array, Int32) Copies all the elements of the current OleDbParameterCollection to the specified one-dimensional Array starting at the specified destination Array index. (Overrides DbParameterCollection.CopyTo(Array, Int32).)
Public method CopyTo(OleDbParameter[], Int32) Copies all the elements of the current OleDbParameterCollection to the specified OleDbParameterCollection starting at the specified destination index.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that iterates through the OleDbParameterCollection. (Overrides DbParameterCollection.GetEnumerator().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetParameter(Int32) Returns the DbParameter object at the specified index in the collection. (Inherited from DbParameterCollection.)
Protected method GetParameter(String) Returns DbParameter the object with the specified name. (Inherited from DbParameterCollection.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf(Object) The location of the specified Object within the collection. (Overrides DbParameterCollection.IndexOf(Object).)
Public method IndexOf(OleDbParameter) Gets the location of the specified OleDbParameter within the collection.
Public method IndexOf(String) Gets the location of the specified OleDbParameter with the specified name. (Overrides DbParameterCollection.IndexOf(String).)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method Insert(Int32, OleDbParameter) Inserts a OleDbParameter object into the OleDbParameterCollection at the specified index.
Public method Insert(Int32, Object) Inserts a Object into the OleDbParameterCollection at the specified index. (Overrides DbParameterCollection.Insert(Int32, Object).)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method Remove(Object) Removes the Object object from the OleDbParameterCollection. (Overrides DbParameterCollection.Remove(Object).)
Public method Remove(OleDbParameter) Removes the OleDbParameter from the OleDbParameterCollection.
Public method RemoveAt(Int32) Removes the OleDbParameter from the OleDbParameterCollection at the specified index. (Overrides DbParameterCollection.RemoveAt(Int32).)
Public method RemoveAt(String) Removes the OleDbParameter from the OleDbParameterCollection at the specified parameter name. (Overrides DbParameterCollection.RemoveAt(String).)
Protected method SetParameter(Int32, DbParameter) Sets the DbParameter object at the specified index to a new value. (Inherited from DbParameterCollection.)
Protected method SetParameter(String, DbParameter) Sets the DbParameter object with the specified name to a new value. (Inherited from DbParameterCollection.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private property IDataParameterCollection.Item Gets or sets the parameter at the specified index. (Inherited from DbParameterCollection.)
Explicit interface implemetation Private property IList.Item Gets or sets the element at the specified index. (Inherited from DbParameterCollection.)
Top

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.

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;
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ