Share via

PointCardRW.BeginRemoval Method

  • Article

2/27/2008

Starts point card removal processing.

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

Syntax

'Declaration
Public MustOverride Sub BeginRemoval ( _
    timeout As Integer _
)

public abstract void BeginRemoval (
    int timeout
)

public:
virtual void BeginRemoval (
    int timeout
) abstract

public abstract void BeginRemoval (
    int timeout
)

public abstract function BeginRemoval (
    timeout : int
)

Parameters

  • timeout
    Gives the number of milliseconds before failing the method. If zero, the BeginRemoval method tries to begin removal mode, then returns the appropriate status immediately. If WaitForever, BeginRemoval tries to begin the Removal mode, then waits as long as needed until the point card is ejected or an error occurs.

Remarks

When it is called, the point card reader/writer is made ready to eject a point card or start a print card ejection mode. BeginRemoval is paired with the EndRemoval method for controlling point card removal.

A device with the sensor in the entrance ends normally when a card is ejected from the point card reader/writer.

A device without the sensor ends normally when ejection processing is implemented.

If the point card reader/writer cannot be put into Removal or Ejection mode, an error is returned to the application. Otherwise, the service object continues to monitor point card removal until one of the following occurs:

  • The point card is successfully ejected. In this case, the service object returns a Success status.

  • The point card is not ejected before timeout milliseconds have elapsed, or an error is reported by the point card reader/writer. In this case, the service object either returns Time-out or another error. The point card reader/writer remains in point card ejection mode. This allows an application to perform some user interaction and reissue the BeginRemoval method without altering the point card handling mechanism.

BeginRemoval may throw a PosControlException exception with the following ErrorCodes:

Value

Meaning

Busy

This operation cannot be performed because asynchronous output is in progress.

Illegal

An invalid timeout parameter is specified.

Timeout

The specified time has elapsed without the point card being suitably ejected.

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
CapCardEntranceSensor
CardState
PointCardRW.BeginInsertion Method
EndInsertion
EndRemoval