Share via


PointCardRW.ClearPrintWrite Method

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

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

Usage

'Usage
Dim kind As PointCardAreas
Dim horizontalPosition As Integer
Dim verticalPosition As Integer
Dim width As Integer
Dim height As Integer
Dim pointCardRW1 As PointCardRW
pointCardRW1.ClearPrintWrite(kind, horizontalPosition, verticalPosition, width, height)

Syntax

'Declaration
Public MustOverride Sub ClearPrintWrite( _
    ByVal kind As PointCardAreas, _
    ByVal horizontalPosition As Integer, _
    ByVal verticalPosition As Integer, _
    ByVal width As Integer, _
    ByVal height As Integer _
)
public abstract void ClearPrintWrite(
    PointCardAreas kind,
    int horizontalPosition,
    int verticalPosition,
    int width,
    int height
);
public: abstract Void ClearPrintWrite(
    PointCardAreas^ kind,
    Int32 horizontalPosition,
    Int32 verticalPosition,
    Int32 width,
    Int32 height
);
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
) : Void;

Parameters

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

    1: PrintingArea

    2: MagneticTracks

    3: PrintingAreaAndMagneticTracks

  • 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 entire printing area.

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

ClearPrintWrite returns void if successful, and can throw the following exceptions:

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.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

See Also

Reference

PointCardRW Class
PointCardRW Members
Microsoft.PointOfService Namespace
CapClearPrint
CapPrint