SqlParameter.Value Property

Reference

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Assemblies:: netstandard.dll, System.Data.SqlClient.dll

Package:: System.Data.SqlClient v4.8.6

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the value of the parameter.

public:
 virtual property System::Object ^ Value { System::Object ^ get(); void set(System::Object ^ value); };

public:
 property System::Object ^ Value { System::Object ^ get(); void set(System::Object ^ value); };

public override object Value { get; set; }

[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.StringConverter))]
[System.Data.DataSysDescription("DataParameter_Value")]
public object Value { get; set; }

[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.StringConverter))]
public override object Value { get; set; }

member this.Value : obj with get, set

[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.StringConverter))>]
[<System.Data.DataSysDescription("DataParameter_Value")>]
member this.Value : obj with get, set

[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.StringConverter))>]
member this.Value : obj with get, set

Public Overrides Property Value As Object

Public Property Value As Object

Property Value

Object

An Object that is the value of the parameter. The default value is null.

Implements

Value

Attributes: TypeConverterAttribute DataSysDescriptionAttribute

Examples

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

static void CreateSqlParameterVersion()
{
    SqlParameter parameter = new SqlParameter("Description", SqlDbType.VarChar, 88);
    parameter.Value = "garden hose";
}

Private Sub CreateSqlParameterVersion()
    Dim parameter As New SqlParameter("Description", SqlDbType.VarChar, 88)
    parameter.Value = "garden hose"
End Sub

Remarks

For input parameters, the value is bound to the SqlCommand that is sent to the server. For output and return value parameters, the value is set on completion of the SqlCommand and after the SqlDataReader is closed.

This property can be set to null or DBNull.Value. Use DBNull.Value to send a NULL value as the value of the parameter. Use null or do not set Value to use the default value for the parameter.

An exception is thrown if non-Unicode XML data is passed as a string.

If the application specifies the database type, the bound value is converted to that type when the provider sends the data to the server. The provider tries to convert any type of value if it supports the IConvertible interface. Conversion errors may result if the specified type is not compatible with the value.

Both the DbType and SqlDbType properties can be inferred by setting the Value.

The Value property is overwritten by SqlDataAdapter.UpdateCommand.

For information about streaming, see SqlClient Streaming Support.

Applies to

Share via