SqlParameter Constructor (String, SqlDbType, Int32) (System.Data.SqlClient)

Switch View :

Classic

Lightweight

ScriptFree

Site Feedback

.NET Framework Class Library

SqlParameter Constructor (String, SqlDbType, Int32)

Initializes a new instance of the SqlParameter class that uses the parameter name, the SqlDbType, and the size.

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

Syntax

Visual Basic

Public Sub New ( _
	parameterName As String, _
	dbType As SqlDbType, _
	size As Integer _
)

public SqlParameter(
	string parameterName,
	SqlDbType dbType,
	int size
)

Visual C++

public:
SqlParameter(
	String^ parameterName, 
	SqlDbType dbType, 
	int size
)

new : 
        parameterName:string * 
        dbType:SqlDbType * 
        size:int -> SqlParameter

Parameters

parameterName: Type: System.String
The name of the parameter to map.

dbType: Type: System.Data.SqlDbType
One of the SqlDbType values.

size: Type: System.Int32
The length of the parameter.

Exceptions

Exception	Condition
ArgumentException	The value supplied in the dbType parameter is an invalid back-end data type.

Remarks

The Size is inferred from the value of the dbType parameter if it is not explicitly set in the size parameter.

Examples

The following example creates a SqlParameter and sets some of its properties.

Visual Basic


Private Sub AddSqlParameter(ByVal command As SqlCommand, _
    ByVal paramValue As String)

    Dim parameter As New SqlParameter("@Description", _
        SqlDbType.VarChar, 88)
    With parameter
        .IsNullable = True
        .Direction = ParameterDirection.Output
        .Value = paramValue
    End With

    command.Parameters.Add(parameter)
End Sub


private static void AddSqlParameter(SqlCommand command, 
    string paramValue)
{
    SqlParameter parameter = new SqlParameter("@Description", 
        SqlDbType.VarChar, 88);
    parameter.IsNullable = true;
    parameter.Direction = ParameterDirection.Output;
    parameter.Value = paramValue;

    command.Parameters.Add(parameter);
}

Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

SqlParameter Class

SqlParameter Overload

System.Data.SqlClient Namespace

Other Resources

Commands and Parameters (ADO.NET)

DataAdapter Parameters (ADO.NET)

SQL Server and ADO.NET

ADO.NET Managed Providers and DataSet Developer Center

Community Content

Andy Hush

MAX types

This page should probably mention that -1 should be sent for length if using varchar(MAX), nvarchar(MAX), or varbinary(MAX).