This documentation is archived and is not being maintained.

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

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
)
public SqlParameter (
	String parameterName, 
	SqlDbType dbType, 
	int size, 
	ParameterDirection direction, 
	boolean isNullable, 
	byte precision, 
	byte scale, 
	String sourceColumn, 
	DataRowVersion sourceVersion, 
	Object value
)
public function SqlParameter (
	parameterName : String, 
	dbType : SqlDbType, 
	size : int, 
	direction : ParameterDirection, 
	isNullable : boolean, 
	precision : byte, 
	scale : byte, 
	sourceColumn : String, 
	sourceVersion : DataRowVersion, 
	value : Object
)
Not applicable.

Parameters

parameterName

The name of the parameter to map.

dbType

One of the SqlDbType values.

size

The length of the parameter.

direction

One of the ParameterDirection values.

isNullable

true if the value of the field can be null; otherwise false.

precision

The total number of digits to the left and right of the decimal point to which Value is resolved.

scale

The total number of decimal places to which Value is resolved.

sourceColumn

The name of the source column.

sourceVersion

One of the DataRowVersion values.

value

An Object that is the value of the SqlParameter.

Exception typeCondition

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);
}

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Show: