This topic has not yet been rated - Rate this topic

OdbcParameterCollection Class

Represents a collection of parameters relevant to an OdbcCommand and their respective mappings to columns in a DataSet. This class cannot be inherited.

System.Object
  System.MarshalByRefObject
    System.Data.Common.DbParameterCollection
      System.Data.Odbc.OdbcParameterCollection

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

The OdbcParameterCollection type exposes the following members.

  Name Description
Public property Count Returns an Integer that contains the number of elements in the OdbcParameterCollection. Read-only. (Overrides DbParameterCollection.Count.)
Public property IsFixedSize Gets a value that indicates whether the OdbcParameterCollection has a fixed size. Read-only. (Overrides DbParameterCollection.IsFixedSize.)
Public property IsReadOnly Gets a value that indicates whether the OdbcParameterCollection is read-only. (Overrides DbParameterCollection.IsReadOnly.)
Public property IsSynchronized Gets a value that indicates whether the OdbcParameterCollection is synchronized. Read-only. (Overrides DbParameterCollection.IsSynchronized.)
Public property Item[Int32] Gets or sets the OdbcParameter at the specified index.
Public property Item[String] Gets or sets the OdbcParameter with the specified name.
Public property SyncRoot Gets an object that can be used to synchronize access to the OdbcParameterCollection. Read-only. (Overrides DbParameterCollection.SyncRoot.)
Top
  Name Description
Public method Add(Object) Adds the specified OdbcParameter object to the OdbcParameterCollection. (Overrides DbParameterCollection.Add(Object).)
Public method Add(OdbcParameter) Adds the specified OdbcParameter to the OdbcParameterCollection.
Public method Add(String, OdbcType) Adds an OdbcParameter to the OdbcParameterCollection, given the parameter name and data type.
Public method Add(String, Object) Obsolete. Adds an OdbcParameter to the OdbcParameterCollection given the parameter name and value.
Public method Add(String, OdbcType, Int32) Adds an OdbcParameter to the OdbcParameterCollection, given the parameter name, data type, and column length.
Public method Add(String, OdbcType, Int32, String) Adds an OdbcParameter to the OdbcParameterCollection 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 OdbcParameterCollection. (Overrides DbParameterCollection.AddRange(Array).)
Public method AddRange(OdbcParameter[]) Adds an array of OdbcParameter values to the end of the OdbcParameterCollection.
Public method AddWithValue Adds a value to the end of the OdbcParameterCollection.
Public method Clear Removes all OdbcParameter objects from the OdbcParameterCollection. (Overrides DbParameterCollection.Clear().)
Public method Contains(Object) Determines whether the specified Object is in this OdbcParameterCollection. (Overrides DbParameterCollection.Contains(Object).)
Public method Contains(OdbcParameter) Determines whether the specified OdbcParameter is in this OdbcParameterCollection.
Public method Contains(String) Gets a value indicating whether an OdbcParameter object with the specified parameter name exists in the collection. (Overrides DbParameterCollection.Contains(String).)
Public method CopyTo(Array, Int32) Copies all the elements of the current OdbcParameterCollection to the specified one-dimensional Array starting at the specified destination Array index. (Overrides DbParameterCollection.CopyTo(Array, Int32).)
Public method CopyTo(OdbcParameter[], Int32) Copies all the elements of the current OdbcParameterCollection to the specified OdbcParameterCollection 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 OdbcParameterCollection. (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) Gets the location of the specified Object within the collection. (Overrides DbParameterCollection.IndexOf(Object).)
Public method IndexOf(OdbcParameter) Gets the location of the specified OdbcParameter within the collection.
Public method IndexOf(String) Gets the location of the specified OdbcParameter 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, OdbcParameter) Inserts a OdbcParameter object into the OdbcParameterCollection at the specified index.
Public method Insert(Int32, Object) Inserts a Object into the OdbcParameterCollection 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 OdbcParameterCollection. (Overrides DbParameterCollection.Remove(Object).)
Public method Remove(OdbcParameter) Removes the OdbcParameter from the OdbcParameterCollection.
Public method RemoveAt(Int32) Removes the OdbcParameter from the OdbcParameterCollection at the specified index. (Overrides DbParameterCollection.RemoveAt(Int32).)
Public method RemoveAt(String) Removes the OdbcParameter from the OdbcParameterCollection with 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, or else the .NET Framework Data Provider for ODBC raises an error.

The following example assumes that the data source has a table named MoneyTable and a stored procedure named MoneyProcedure, which are defined as follows:

CREATE TABLE MoneyTable (col1 int, col2 smallmoney, col3 decimal);

CREATE PROC MoneyProcedure (@p1 int, @p2 smallmoney, @p3 decimal) 
AS 
INSERT INTO MyTable VALUES (@p1, @p2, @p3);

The example creates parameters and calls the MoneyProcedure stored procedure.


public void CreateMyProc(OdbcConnection connection)
{
    OdbcCommand command = connection.CreateCommand();
    command.CommandText = "{ call MyProc(?,?,?) }";

    OdbcParameter param = new OdbcParameter();
    param.DbType = DbType.Int32;
    param.Value = 1;
    command.Parameters.Add(param);

    param = new OdbcParameter();
    param.DbType = DbType.Decimal;
    param.Value = 1;
    command.Parameters.Add(param);

    param = new OdbcParameter();
    param.DbType = DbType.Decimal;
    param.Value = 1;
    command.Parameters.Add(param);

    command.ExecuteNonQuery();

 }


.NET Framework

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

.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