Scale.TareWeight Property (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

Holds the tare weight of scale data.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustOverride Property TareWeight As Decimal

public abstract decimal TareWeight { get; set; }

public:
virtual property Decimal TareWeight {
    Decimal get () abstract;
    void set (Decimal value) abstract;
}

/** @property */
public abstract Decimal get_TareWeight ()

/** @property */
public abstract void set_TareWeight (Decimal value)

public abstract function get TareWeight () : decimal

public abstract function set TareWeight (value : decimal)

Remarks

The measurement unit is specified in the WeightUnit property. If the CapTareWeight property is set to false, the device does not support setting a tare value and TareWeight is always zero.

Note

POS for .NET does not use an assumed decimal place for TareWeight. The returned value is the actual value and should not be shifted before use.

Tare weight is not included in the item weight returned by the ReadWeight method.

TareWeight is typically initialized to the scale’s default tare weight (usually zero) when the device is first enabled.

Accessing TareWeight can may cause a PosControlException to be thrown with the following ErrorCode:

Value

Meaning

Illegal

CapTareWeight is false or an invalid tare value was specified.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

Scale Class
Scale Members
Microsoft.PointOfService Namespace
Scale.CapTareWeight Property
Scale.ReadWeight Method
WeightUnit