PointCardRW.ClearPrintWrite Method (POS for .NET v1.14 SDK Documentation)

3/2/2014

Erases the printing area of a point card and erases the magnetic track data on a point card or erases the magnetic track data on a point card.

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

Syntax

'Declaration
Public MustOverride Sub ClearPrintWrite ( _
    kind As PointCardAreas, _
    horizontalPosition As Integer, _
    verticalPosition As Integer, _
    width As Integer, _
    height As Integer _
)

public abstract void ClearPrintWrite (
    PointCardAreas kind,
    int horizontalPosition,
    int verticalPosition,
    int width,
    int height
)

public:
virtual void ClearPrintWrite (
    PointCardAreas kind, 
    int horizontalPosition, 
    int verticalPosition, 
    int width, 
    int height
) abstract

public abstract void ClearPrintWrite (
    PointCardAreas kind, 
    int horizontalPosition, 
    int verticalPosition, 
    int width, 
    int height
)

public abstract function ClearPrintWrite (
    kind : PointCardAreas, 
    horizontalPosition : int, 
    verticalPosition : int, 
    width : int, 
    height : int
)

Parameters

• kind
  Defines the parts of the point card that will be cleared (erased).

• horizontalPosition
  The horizontal start position for erasing the printing area. The value is in MapMode units if CapPrintMode is true.

• verticalPosition
  The vertical start position for erasing the printing area. The value is in MapMode units if CapPrintMode is true.

• width
  The width used for erasing the printing area. The value is in MapMode units if CapPrintMode is true.

• height
  The height used for erasing the printing area. The value is in MapMode units if CapPrintMode is true.

Remarks

When the CapPrint and CapClearPrint properties are both true, ClearPrintWrite can be used to clear the printing area of a point card. The horizontalPosition, verticalPosition, width, and height parameters define the rectangle to clear. If these parameters are 0, 0, -1, –1 respectively, ClearPrintWrite erases the printing area.

The initialization of the magnetic track data relies on the capability of the device.

ClearPrintWrite may throw a PosControlException exception with the following ErrorCodes:

Value	Meaning
Success	ClearPrintWrite was initiated successfully.
Illegal	The point card reader/writer is not in Point Card Removal mode.
Busy	This operation cannot be performed because asynchronous output is in progress.

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

PointCardRW Class
PointCardRW Members
Microsoft.PointOfService Namespace
CapClearPrint
CapPrint