IDataParameter.IsNullable Property

Reference

Definition

Namespace:: System.Data

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

Assembly:: System.Data.Common.dll

Assembly:: System.Data.dll

Assembly:: netstandard.dll

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 a value indicating whether the parameter accepts null values.

public:
 property bool IsNullable { bool get(); };

public bool IsNullable { get; }

member this.IsNullable : bool

Public ReadOnly Property IsNullable As Boolean

Property Value

Boolean

true if null values are accepted; otherwise, false. The default is false.

Examples

The following example creates an instance of the implementing class, 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

Null values are handled using the DBNull class.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via