Share via

CheckScanner.BeginRemoval Method

  • Article

2/27/2008

Starts the document removal process.

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 timeout is set to 0 (zero), the method tries to begin removal mode, returns immediately if this is successful. Otherwise, it throws an exception. If timeout is set to WaitForever (-1), the method tries to begin removal mode, waits as long as needed until either the check is removed or an error occurs.

Remarks

When it is called, the check scanner is made ready to remove a check by opening the device’s check handling "jaws" or starting the device’s ejection mode. BeginRemoval is paired with the EndRemoval method for controlling check removal. Although some Check Scanner devices do not require this kind of processing, the application should use these methods to make sure the application works across different Check Scanner devices.

If the Check Scanner device cannot be put in removal mode, the service object throws an exception. Otherwise, check removal is monitored until either:

  • The check is successfully removed; or

  • The check is not removed before timeout milliseconds have elapsed, or an error is reported by the device. In this case, the service object throws an exception and the check scanner remains in removal mode. This enables the application to perform some user interaction and reissue the BeginRemoval method without altering the check scanner check handling mechanism.

BeginRemoval may cause a PosControlException to be thrown with the following ErrorCodes.

Value

Meaning

Timeout

The value of timeout was reached before removal mode could be initiated.

Busy

If the check scanner is a combination device, the peer device may be busy.

Illegal

An invalid value has been specified for timeout.

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

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