Edit

OdbcParameter.Scale Property

  • Reference

Definition

Namespace:
System.Data.Odbc
Assembly:
System.Data.Odbc.dll
Assembly:
System.Data.dll
Package:
System.Data.Odbc v6.0.0
Package:
System.Data.Odbc v7.0.0
Package:
System.Data.Odbc v8.0.0
Package:
System.Data.Odbc v9.0.0-preview.2.24128.5
Source:
OdbcParameter.cs
Source:
OdbcParameter.cs
Source:
OdbcParameter.cs

Gets or sets the number of decimal places to which Value is resolved.

public:
 property System::Byte Scale { System::Byte get(); void set(System::Byte value); };
public byte Scale { get; set; }
member this.Scale : byte with get, set
Public Property Scale As Byte

Property Value

Byte

The number of decimal places to which Value is resolved. The default is 0.

Implements

Scale

Examples

The following example creates an OdbcParameter and sets some of its properties.

Public Sub CreateOdbcParameter()  
    Dim parameter As New OdbcParameter("Price", OdbcType.Decimal)  
    parameter.Value = 3.1416  
    parameter.Precision = 8  
    parameter.Scale = 4  
End Sub   

public void CreateOdbcParameter()   
 {  
    OdbcParameter parameter = new OdbcParameter("Price", OdbcType.Decimal);  
    parameter.Value = 3.1416;  
    parameter.Precision = 8;  
    parameter.Scale = 4;  
 }

Remarks

The Scale property is used only for decimal and numeric input parameters.

The effect of setting this property to a value other than the value in the database depends on the implementation of the data provider and may return an error code, or truncate or round data.

The Scale property only affects parameters whose OdbcType is Decimal or Numeric. For other data types, Scale is ignored.

When using SQL Server Native Client 10 (or later) to bind a parameter whose type is Decimal, Numeric, VarNumeric, DBDate, or DBTimeStamp, you must manually specify an appropriate Scale value.

Note

Use of this property to coerce data passed to the database is not supported. To round, truncate, or otherwise coerce data before passing it to the database, use the Math class that is part of the System namespace prior to assigning a value to the parameter's Value property.

Note

.NET Framework data providers that are included with the .NET Framework version 1.0 do not verify the scale of Decimal parameter values. This can cause modified data being inserted at the data source. If you are using .NET Framework version 1.0, validate the scale of decimal values before setting the parameter value. When you use .NET Framework version 1.1 or later versions, scale values that exceed the decimal parameter scale might only be truncated in scale, if that is the behavior of the underlying ODBC driver.

Applies to

See also