SqlParameter.DbType 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 SqlDbType of the parameter.

public:
 virtual property System::Data::DbType DbType { System::Data::DbType get(); void set(System::Data::DbType value); };

public:
 property System::Data::DbType DbType { System::Data::DbType get(); void set(System::Data::DbType value); };

public override System.Data.DbType DbType { get; set; }

[System.ComponentModel.Browsable(false)]
[System.Data.DataSysDescription("DataParameter_DbType")]
public System.Data.DbType DbType { get; set; }

member this.DbType : System.Data.DbType with get, set

[<System.ComponentModel.Browsable(false)>]
[<System.Data.DataSysDescription("DataParameter_DbType")>]
member this.DbType : System.Data.DbType with get, set

Public Overrides Property DbType As DbType

Public Property DbType As DbType

Property Value

DbType

One of the SqlDbType values. The default is NVarChar.

Implements

DbType

Attributes: BrowsableAttribute DataSysDescriptionAttribute

Examples

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

    private static void AddSqlParameter(SqlCommand command,
        string paramValue)
    {
        SqlParameter parameter = new SqlParameter(
            "@Description", SqlDbType.VarChar);
        parameter.Value = paramValue;
        parameter.IsNullable = true;
        command.Parameters.Add(parameter);
    }

private static void SetParameterToNull(IDataParameter parameter)
{
    if (parameter.IsNullable)
    {
        parameter.Value = DBNull.Value;
    }
    else
    {
        throw new ArgumentException("Parameter provided is not nullable", "parameter");
    }
}

 Private Sub AddSqlParameter(ByVal command As SqlCommand, _
     ByVal paramValue As String)

     Dim parameter As New SqlParameter( _
         "@Description", SqlDbType.NVarChar, 16)
     parameter.Value = paramValue
     parameter.IsNullable = True
     command.Parameters.Add(parameter)
 End Sub

 Private Shared Sub SetParameterToNull(parameter As IDataParameter)
     If parameter.IsNullable Then
     parameter.Value = DBNull.Value
     Else
         Throw New ArgumentException("Parameter provided is not nullable", "parameter")
     End If
End Sub

Remarks

The SqlDbType and DbType are linked. Therefore, setting the DbType changes the SqlDbType to a supporting SqlDbType.

For a list of the supported data types, see the appropriate SqlDbType member. For more information, see DataAdapter Parameters.

Applies to

Dela via