SqlParameter Class (System.Data.SqlClient)

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

SqlParameter Class

Represents a parameter to a SqlCommand and optionally its mapping to DataSet columns. This class cannot be inherited.

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

Syntax

Visual Basic (Declaration)

Public NotInheritable Class SqlParameter _
    Inherits DbParameter _
    Implements IDbDataParameter, IDataParameter, ICloneable

Visual Basic (Usage)

Dim instance As SqlParameter

public sealed class SqlParameter : DbParameter, 
    IDbDataParameter, IDataParameter, ICloneable

Visual C++

public ref class SqlParameter sealed : public DbParameter, 
    IDbDataParameter, IDataParameter, ICloneable

JScript

public final class SqlParameter extends DbParameter implements IDbDataParameter, IDataParameter, ICloneable

Remarks

Parameter names are not case sensitive.

For more information, along with additional sample code demonstrating how to use parameters, see Commands and Parameters (ADO.NET).

Examples

The following example creates multiple instances of SqlParameter through the SqlParameterCollection collection within the SqlDataAdapter. These parameters are used to select data from the data source and put the data in the DataSet. This example assumes that a DataSet and a SqlDataAdapter have already been created by using the appropriate schema, commands, and connection. For more information and additional examples on using parameters, see Retrieving and Modifying Data in ADO.NET and Configuring Parameters and Parameter Data Types (ADO.NET).

Visual Basic

Public Sub AddSqlParameters()
    ' ...
    ' create categoriesDataSet and categoriesAdapter
    ' ...
    categoriesAdapter.SelectCommand.Parameters.Add( _
        "@CategoryName", SqlDbType.VarChar, 80).Value = "toasters"
    categoriesAdapter.SelectCommand.Parameters.Add( _
        "@SerialNum", SqlDbType.Int).Value = 239

    categoriesAdapter.Fill(categoriesDataSet)
End Sub

public void AddSqlParameters() 
{
// ...
// create categoriesDataSet and categoriesAdapter
// ...

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

}

Inheritance Hierarchy

System..::.Object
  System..::.MarshalByRefObject
    System.Data.Common..::.DbParameter
      System.Data.SqlClient..::.SqlParameter

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

Reference

SqlParameter Members

System.Data.SqlClient Namespace

SqlParameterCollection

SqlCommand

Other Resources

Commands and Parameters (ADO.NET)

DataAdapter Parameters (ADO.NET)

SQL Server and ADO.NET