Export (0) Print
Expand All

SqlParameterCollection Class

Represents a collection of parameters relevant to a SqlCommand as well as their respective mappings to columns in a DataSet. This class cannot be inherited.

For a list of all members of this type, see SqlParameterCollection Members.

System.Object
   System.MarshalByRefObject
      System.Data.SqlClient.SqlParameterCollection

[Visual Basic]
NotInheritable Public Class SqlParameterCollection
   Inherits MarshalByRefObject
   Implements IDataParameterCollection, IList, ICollection, _
   IEnumerable
[C#]
public sealed class SqlParameterCollection : MarshalByRefObject,
   IDataParameterCollection, IList, ICollection, IEnumerable
[C++]
public __gc __sealed class SqlParameterCollection : public
   MarshalByRefObject, IDataParameterCollection, IList,
   ICollection,
   IEnumerable
[JScript]
public class SqlParameterCollection extends MarshalByRefObject
   implements IDataParameterCollection, IList, ICollection,
   IEnumerable

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Remarks

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.

Example

[Visual Basic, C#, C++] The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection within the SqlDataAdapter. These parameters are used to select data within the data source and place the data in the DataSet. This code assumes that a DataSet and a SqlDataAdapter have already been created with the appropriate schema, commands, and connection.

[Visual Basic] 
Public Sub AddSqlParameters()
    ' ...
    ' create myDataSet and myDataAdapter
    ' ...
    myDataAdapter.SelectCommand.Parameters.Add("@CategoryName", SqlDbType.VarChar, 80).Value = "toasters"
    myDataAdapter.SelectCommand.Parameters.Add("@SerialNum", SqlDbType.Int).Value = 239
    
    myDataAdapter.Fill(myDataSet)
End Sub 'AddSqlParameters 

[C#] 
public void AddSqlParameters() 
{
// ...
// create myDataSet and myDataAdapter
// ...

  myDataAdapter.SelectCommand.Parameters.Add("@CategoryName", SqlDbType.VarChar, 80).Value = "toasters";
  myDataAdapter.SelectCommand.Parameters.Add("@SerialNum", SqlDbType.Int).Value = 239;
  myDataAdapter.Fill(myDataSet);

}

[C++] 
public:
void AddSqlParameters() 
{
// ...
// create myDataSet and myDataAdapter
// ...

  myDataAdapter->SelectCommand->Parameters->Add(S"@CategoryName", SqlDbType::VarChar, 80)->Value = S"toasters";
  myDataAdapter->SelectCommand->Parameters->Add(S"@SerialNum", SqlDbType::Int)->Value = __box(239);
  myDataAdapter->Fill(myDataSet);

}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Data.SqlClient

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

Assembly: System.Data (in System.Data.dll)

See Also

SqlParameterCollection Members | System.Data.SqlClient Namespace

Show:
© 2014 Microsoft