Micr.BeginRemoval Method

2/27/2008

Starts the check 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
  The timeout parameter gives the number of milliseconds before failing the method.If timeout is zero, BeginRemoval tries to begin Removal mode, then returns the appropriate status immediately.If timeout is WaitForever, BeginRemoval tries to begin Removal mode, then waits until either the check is removed or an error occurs.

Remarks

When BeginRemoval is called, the MICR is made ready to remove a check by opening the MICR's check handling "jaws" or starting a MICR's check Ejection mode. BeginRemoval is paired with the EndRemoval method for controlling check removal. For MICR devices that do not require this kind of processing, the BeginRemoval and EndRemoval methods return Success. However, the application should still use these methods to guarantee application portability across different MICR devices.

If the MICR device cannot be put into Removal or Ejection mode, an error is returned to the application. Otherwise, the service object continues to monitor check removal until either:

• The check is successfully removed. In this case, the service object returns a Success status.

-Or-

• The check is not removed before time-out milliseconds have elapsed, or an error is reported by the MICR device. In this case, the service object either returns Timeout or another error. The MICR device remains in check Removal mode. This allows an application to perform some user interaction and reissue the BeginRemoval method without altering the MICR check handling mechanism.

BeginRemoval may cause a PosControlException exception to be thrown with the following ErrorCode:

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

Micr Class
Micr Members
Microsoft.PointOfService Namespace
Micr.BeginInsertion Method
EndInsertion
EndRemoval