This documentation is archived and is not being maintained.

SqlParameter Constructor (String, SqlDbType, Int32, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)

Initializes a new instance of the SqlParameter class that uses the parameter name, the type of the parameter, the size of the parameter, a ParameterDirection, the precision of the parameter, the scale of the parameter, the source column, a DataRowVersion to use, and the value of the parameter.

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

public SqlParameter(
	string parameterName,
	SqlDbType dbType,
	int size,
	ParameterDirection direction,
	bool isNullable,
	byte precision,
	byte scale,
	string sourceColumn,
	DataRowVersion sourceVersion,
	Object value
)

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.
direction
Type: System.Data.ParameterDirection
One of the ParameterDirection values.
isNullable
Type: System.Boolean
true if the value of the field can be null; otherwise false.
precision
Type: System.Byte
The total number of digits to the left and right of the decimal point to which Value is resolved.
scale
Type: System.Byte
The total number of decimal places to which Value is resolved.
sourceColumn
Type: System.String
The name of the source column.
sourceVersion
Type: System.Data.DataRowVersion
One of the DataRowVersion values.
value
Type: System.Object
An Object that is the value of the SqlParameter.

ExceptionCondition
ArgumentException

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

The Size and Precision are inferred from the value of the dbType parameter if they are not explicitly set in the size and precision parameters.

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


private static void AddSqlParameter(SqlCommand command)
{
    SqlParameter parameter = new SqlParameter("@Description", 
        SqlDbType.VarChar, 11, ParameterDirection.Input,
        true, 0, 0, "Description", DataRowVersion.Current, 
        "garden hose");
    parameter.IsNullable = true;

    command.Parameters.Add(parameter);
}


.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

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.
Show: