IDataParameter.Value Property

 
System_CAPS_noteNote

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.

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

Property Value As Object

Property Value

Type: System.Object

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

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

When sending a null parameter value to the server, the user must specify DBNull, not null. The null value in the system is an empty object that has no value. DBNull is used to represent null values.

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 attempts 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.

The Value property is overwritten by Update.

The following example creates an instance of the implementing class, SqlParameter, and sets some of its properties.

Public Sub CreateSqlParameter()
    Dim parameter As New SqlParameter( _
        "@Description", SqlDbType.VarChar)
    parameter.Value = "garden hose"
    parameter.Size = 11
End Sub 

.NET Framework
Available since 1.1
Return to top
Show: