SqlParameter.SqlValue Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the value of the parameter as an SQL type.

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

public object SqlValue { get; set; }

Property Value

Type: System.Object

An Object that is the value of the parameter, using SQL types. The default value is null.

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 Value. Use Value to send a NULL value as the value of the parameter. Use null or do not set SqlValue to use the default value for the parameter.

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.

Use the Value property to return parameter values as common language runtime (CLR) types.

For information about streaming, see SqlClient Streaming Support.

.NET Framework
Available since 2.0
Return to top