Export (0) Print
Expand All

OleDbParameterCollection Class

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

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.

  NameDescription
Public propertyCountReturns an integer that contains the number of elements in the OleDbParameterCollection. Read-only. (Overrides DbParameterCollection.Count.)
Public propertyIsFixedSizeGets a value that indicates whether the OleDbParameterCollection has a fixed size. Read-only. (Overrides DbParameterCollection.IsFixedSize.)
Public propertyIsReadOnlyGets a value that indicates whether the OleDbParameterCollection is read-only. (Overrides DbParameterCollection.IsReadOnly.)
Public propertyIsSynchronizedGets a value that indicates whether the OleDbParameterCollection is synchronized. Read-only. (Overrides DbParameterCollection.IsSynchronized.)
Public propertyItem[Int32]Gets or sets the OleDbParameter at the specified index.
Public propertyItem[String]Gets or sets the OleDbParameter with the specified name.
Public propertySyncRootGets an object that can be used to synchronize access to the OleDbParameterCollection. Read-only. (Overrides DbParameterCollection.SyncRoot.)
Top

  NameDescription
Public methodAdd(Object)Adds the specified OleDbParameter object to the OleDbParameterCollection. (Overrides DbParameterCollection.Add(Object).)
Public methodAdd(OleDbParameter)Adds the specified OleDbParameter to the OleDbParameterCollection.
Public methodAdd(String, OleDbType)Adds an OleDbParameter to the OleDbParameterCollection, given the parameter name and data type.
Public methodAdd(String, Object) Obsolete. Adds an OleDbParameter to the OleDbParameterCollection given the parameter name and value.
Public methodAdd(String, OleDbType, Int32)Adds an OleDbParameter to the OleDbParameterCollection given the parameter name, data type, and column length.
Public methodAdd(String, OleDbType, Int32, String)Adds an OleDbParameter to the OleDbParameterCollection given the parameter name, data type, column length, and source column name.
Public methodAddRange(Array)Adds an array of values to the end of the OleDbParameterCollection. (Overrides DbParameterCollection.AddRange(Array).)
Public methodAddRange(OleDbParameter[])Adds an array of OleDbParameter values to the end of the OleDbParameterCollection.
Public methodAddWithValueAdds a value to the end of the OleDbParameterCollection.
Public methodClearRemoves all OleDbParameter objects from the OleDbParameterCollection. (Overrides DbParameterCollection.Clear().)
Public methodContains(Object)Determines whether the specified Object is in this OleDbParameterCollection. (Overrides DbParameterCollection.Contains(Object).)
Public methodContains(OleDbParameter)Determines whether the specified OleDbParameter is in this OleDbParameterCollection.
Public methodContains(String)Determines whether the specified String is in this OleDbParameterCollection. (Overrides DbParameterCollection.Contains(String).)
Public methodCopyTo(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 methodCopyTo(OleDbParameter[], Int32)Copies all the elements of the current OleDbParameterCollection to the specified OleDbParameterCollection starting at the specified destination index.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that iterates through the OleDbParameterCollection. (Overrides DbParameterCollection.GetEnumerator().)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOf(Object)The location of the specified Object within the collection. (Overrides DbParameterCollection.IndexOf(Object).)
Public methodIndexOf(OleDbParameter)Gets the location of the specified OleDbParameter within the collection.
Public methodIndexOf(String)Gets the location of the specified OleDbParameter with the specified name. (Overrides DbParameterCollection.IndexOf(String).)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodInsert(Int32, OleDbParameter)Inserts a OleDbParameter object into the OleDbParameterCollection at the specified index.
Public methodInsert(Int32, Object)Inserts a Object into the OleDbParameterCollection at the specified index. (Overrides DbParameterCollection.Insert(Int32, Object).)
Public methodRemove(Object)Removes the Object object from the OleDbParameterCollection. (Overrides DbParameterCollection.Remove(Object).)
Public methodRemove(OleDbParameter)Removes the OleDbParameter from the OleDbParameterCollection.
Public methodRemoveAt(Int32)Removes the OleDbParameter from the OleDbParameterCollection at the specified index. (Overrides DbParameterCollection.RemoveAt(Int32).)
Public methodRemoveAt(String)Removes the OleDbParameter from the OleDbParameterCollection at the specified parameter name. (Overrides DbParameterCollection.RemoveAt(String).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyIDataParameterCollection.ItemGets or sets the parameter at the specified index. (Inherited from DbParameterCollection.)
Explicit interface implemetationPrivate propertyIList.ItemGets 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.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft