PosPrinter.BeginRemoval Method (POS for .NET v1.12 SDK Documentation)

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

Remarks

BeginRemoval is paired with the EndRemoval method to control form removal.

The service object makes the printer ready to remove a form by opening the form handling "jaws" or by starting a form-ejection mode. If the Printer device cannot be put into removal or ejection mode, the service object throws an exception. Otherwise, the service object continues to monitor form removal until one of the following conditions is true:

The form is successfully removed.

The form is not removed before timeout milliseconds have elapsed. In this case, the service object throws a Timeout exception.

If an error is reported by the Printer device, the service throws an exception. The Printer device remains in form-removal mode. This allows an application to perform some user interaction and reissue the BeginRemoval method without altering the form-handling mechanism.

If timeout is set to 0 (zero), BeginRemoval tries to start removal mode, then returns immediately. If timeout is set to the constant WaitForever, BeginRemoval tries to start removal mode, then waits until either the form is removed or an error occurs.

Before it calls this method, the application must open, claim, and enable the device.

BeginRemoval may throw a PosControlException with the following ErrorCodes:

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

PosPrinter Class
PosPrinter Members
Microsoft.PointOfService Namespace
PosPrinter.BeginInsertion Method
EndInsertion
EndRemoval
PosCommon.WaitForever Field