Share via

FiscalPrinter.BeginRemoval Method

  • Article

2/27/2008

Starts form-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
    Specifies the number of milliseconds before failing the method. If zero, BeginRemoval tries to begin removal mode, then immediately returns the appropriate status. If WaitForever, BeginRemoval tries to begin removal mode, then waits as long as needed until either the form is removed or an error occurs.

Remarks

When it is called, the printer is made ready to remove a form by opening the form-handling "jaws" or starting a form-ejection mode. BeginRemoval is paired with the EndRemoval method for controlling form removal.

If the printer device cannot be put into removal or ejection mode, an error is returned to the application. Otherwise, the service object continues to monitor form removal until one of the following results occurs:

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

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

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

Value

Description

Busy

Cannot perform while output is in progress.

Illegal

The printer does not have a slip station (see the CapSlpPresent property).

Timeout

The specified time has elapsed without the form being properly removed.

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

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