OdbcParameterCollection Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a collection of parameters relevant to an OdbcCommand and their respective mappings to columns in a DataSet. This class cannot be inherited.
public ref class OdbcParameterCollection sealed : System::Data::Common::DbParameterCollection
public sealed class OdbcParameterCollection : System.Data.Common.DbParameterCollection
type OdbcParameterCollection = class
inherit DbParameterCollection
Public NotInheritable Class OdbcParameterCollection
Inherits DbParameterCollection
- Inheritance
Examples
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();
}
Public Sub CreateMyProc(ByVal connection As OdbcConnection)
Dim command As OdbcCommand = connection.CreateCommand()
Command.CommandText = "{ call MyProc(?,?,?) }"
Dim param As 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()
End Sub
Remarks
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.
Properties
| Name | Description |
|---|---|
| Count |
Returns an Integer that contains the number of elements in the OdbcParameterCollection. Read-only. |
| IsFixedSize |
Gets a value that indicates whether the OdbcParameterCollection has a fixed size. Read-only. |
| IsReadOnly |
Gets a value that indicates whether the OdbcParameterCollection is read-only. |
| IsSynchronized |
Gets a value that indicates whether the OdbcParameterCollection is synchronized. Read-only. |
| Item[Int32] |
Gets or sets the OdbcParameter at the specified index. |
| Item[String] |
Gets or sets the OdbcParameter with the specified name. |
| SyncRoot |
Gets an object that can be used to synchronize access to the OdbcParameterCollection. Read-only. |
Methods
| Name | Description |
|---|---|
| Add(Object) |
Adds the specified OdbcParameter object to the OdbcParameterCollection. |
| Add(OdbcParameter) |
Adds the specified OdbcParameter to the OdbcParameterCollection. |
| Add(String, Object) |
Obsolete.
Adds an OdbcParameter to the OdbcParameterCollection given the parameter name and value. |
| Add(String, OdbcType, Int32, String) |
Adds an OdbcParameter to the OdbcParameterCollection given the parameter name, data type, column length, and source column name. |
| Add(String, OdbcType, Int32) |
Adds an OdbcParameter to the OdbcParameterCollection, given the parameter name, data type, and column length. |
| Add(String, OdbcType) |
Adds an OdbcParameter to the OdbcParameterCollection, given the parameter name and data type. |
| AddRange(Array) |
Adds an array of values to the end of the OdbcParameterCollection. |
| AddRange(OdbcParameter[]) |
Adds an array of OdbcParameter values to the end of the OdbcParameterCollection. |
| AddWithValue(String, Object) |
Adds a value to the end of the OdbcParameterCollection. |
| Clear() |
Removes all OdbcParameter objects from the OdbcParameterCollection. |
| Contains(Object) |
Determines whether the specified Object is in this OdbcParameterCollection. |
| Contains(OdbcParameter) |
Determines whether the specified OdbcParameter is in this OdbcParameterCollection. |
| Contains(String) |
Gets a value indicating whether an OdbcParameter object with the specified parameter name exists in the collection. |
| CopyTo(Array, Int32) |
Copies all the elements of the current OdbcParameterCollection to the specified one-dimensional Array starting at the specified destination Array index. |
| CopyTo(OdbcParameter[], Int32) |
Copies all the elements of the current OdbcParameterCollection to the specified OdbcParameterCollection starting at the specified destination index. |
| GetEnumerator() |
Returns an enumerator that iterates through the OdbcParameterCollection. |
| IndexOf(Object) |
Gets the location of the specified Object within the collection. |
| IndexOf(OdbcParameter) |
Gets the location of the specified OdbcParameter within the collection. |
| IndexOf(String) |
Gets the location of the specified OdbcParameter with the specified name. |
| Insert(Int32, Object) |
Inserts a Object into the OdbcParameterCollection at the specified index. |
| Insert(Int32, OdbcParameter) |
Inserts a OdbcParameter object into the OdbcParameterCollection at the specified index. |
| Remove(Object) |
Removes the Object object from the OdbcParameterCollection. |
| Remove(OdbcParameter) |
Removes the OdbcParameter from the OdbcParameterCollection. |
| RemoveAt(Int32) |
Removes the OdbcParameter from the OdbcParameterCollection at the specified index. |
| RemoveAt(String) |
Removes the OdbcParameter from the OdbcParameterCollection with the specified parameter name. |