SqlParameterCollection Class
Represents a collection of parameters associated with a SqlCommand and their respective mappings to columns in a DataSet. This class cannot be inherited.
System::MarshalByRefObject
System.Data.Common::DbParameterCollection
System.Data.SqlClient::SqlParameterCollection
Assembly: System.Data (in System.Data.dll)
The SqlParameterCollection type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Count | Returns an Integer that contains the number of elements in the SqlParameterCollection. Read-only. (Overrides DbParameterCollection::Count.) |
![]() | IsFixedSize | Gets a value that indicates whether the SqlParameterCollection has a fixed size. (Overrides DbParameterCollection::IsFixedSize.) |
![]() | IsReadOnly | Gets a value that indicates whether the SqlParameterCollection is read-only. (Overrides DbParameterCollection::IsReadOnly.) |
![]() | IsSynchronized | Gets a value that indicates whether the SqlParameterCollection is synchronized. (Overrides DbParameterCollection::IsSynchronized.) |
![]() | Item[Int32] | Gets the SqlParameter at the specified index. |
![]() | Item[String] | Gets the SqlParameter with the specified name. |
![]() | SyncRoot | Gets an object that can be used to synchronize access to the SqlParameterCollection. (Overrides DbParameterCollection::SyncRoot.) |
| Name | Description | |
|---|---|---|
![]() | Add(Object) | Adds the specified SqlParameter object to the SqlParameterCollection. (Overrides DbParameterCollection::Add(Object).) |
![]() | Add(SqlParameter) | Adds the specified SqlParameter object to the SqlParameterCollection. |
![]() | Add(String, SqlDbType) | Adds a SqlParameter to the SqlParameterCollection given the parameter name and the data type. |
![]() | Add(String, Object) | Obsolete. Adds the specified SqlParameter object to the SqlParameterCollection. |
![]() | Add(String, SqlDbType, Int32) | Adds a SqlParameter to the SqlParameterCollection, given the specified parameter name, SqlDbType and size. |
![]() | Add(String, SqlDbType, Int32, String) | Adds a SqlParameter to the SqlParameterCollection with the parameter name, the data type, and the column length. |
![]() | AddRange(Array) | Adds an array of values to the end of the SqlParameterCollection. (Overrides DbParameterCollection::AddRange(Array).) |
![]() | AddRange(array<SqlParameter>) | Adds an array of SqlParameter values to the end of the SqlParameterCollection. |
![]() | AddWithValue | Adds a value to the end of the SqlParameterCollection. |
![]() | Clear | Removes all the SqlParameter objects from the SqlParameterCollection. (Overrides DbParameterCollection::Clear().) |
![]() | Contains(Object) | Determines whether the specified Object is in this SqlParameterCollection. (Overrides DbParameterCollection::Contains(Object).) |
![]() | Contains(SqlParameter) | Determines whether the specified SqlParameter is in this SqlParameterCollection. |
![]() | Contains(String) | Determines whether the specified parameter name is in this SqlParameterCollection. (Overrides DbParameterCollection::Contains(String).) |
![]() | CopyTo(Array, Int32) | Copies all the elements of the current SqlParameterCollection to the specified one-dimensional Array starting at the specified destination Array index. (Overrides DbParameterCollection::CopyTo(Array, Int32).) |
![]() | CopyTo(array<SqlParameter>, Int32) | Copies all the elements of the current SqlParameterCollection to the specified SqlParameterCollection starting at the specified destination index. |
![]() | 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.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetEnumerator | Returns an enumerator that iterates through the SqlParameterCollection. (Overrides DbParameterCollection::GetEnumerator().) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLifetimeService | 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) | Gets the location of the specified Object within the collection. (Overrides DbParameterCollection::IndexOf(Object).) |
![]() | IndexOf(SqlParameter) | Gets the location of the specified SqlParameter within the collection. |
![]() | IndexOf(String) | Gets the location of the specified SqlParameter with the specified name. (Overrides DbParameterCollection::IndexOf(String).) |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | Insert(Int32, SqlParameter) | Inserts a SqlParameter object into the SqlParameterCollection at the specified index. |
![]() | Insert(Int32, Object) | Inserts an Object into the SqlParameterCollection at the specified index. (Overrides DbParameterCollection::Insert(Int32, Object).) |
![]() | 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 specified SqlParameter from the collection. (Overrides DbParameterCollection::Remove(Object).) |
![]() | Remove(SqlParameter) | Removes the specified SqlParameter from the collection. |
![]() | RemoveAt(Int32) | Removes the SqlParameter from the SqlParameterCollection at the specified index. (Overrides DbParameterCollection::RemoveAt(Int32).) |
![]() | RemoveAt(String) | Removes the SqlParameter from the SqlParameterCollection at the specified parameter name. (Overrides DbParameterCollection::RemoveAt(String).) |
![]() | 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.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IDataParameterCollection::Item | Gets or sets the parameter at the specified index. (Inherited from DbParameterCollection.) |
![]() ![]() | IList::Item | Gets or sets the element at the specified index. (Inherited from DbParameterCollection.) |
If the command contains an ad hoc SQL statement, as opposed to a stored-procedure name, the number of the parameters in the collection must be equal to the number of parameter placeholders within the command text, or SQL Server raises an error. With a stored procedure, all the parameters declared in the stored procedure without a default value must be provided. Parameters declared with a default value are optional. This lets you specify a value other than the default.
For more information with additional sample code demonstrating how to use parameters, see Commands and Parameters (ADO.NET).
The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection. The parameters are used to select data within the data source and populate the DataSet. This code assumes that a DataSet and a SqlDataAdapter have already been created with the appropriate schema, commands, and connection.
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.

