Share via


FiscalPrinter.BeginInsertion Method

2/27/2008

Starts slip processing.

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

Syntax

'Declaration
Public MustOverride Sub BeginInsertion ( _
    timeout As Integer _
)
public abstract void BeginInsertion (
    int timeout
)
public:
virtual void BeginInsertion (
    int timeout
) abstract
public abstract void BeginInsertion (
    int timeout
)
public abstract function BeginInsertion (
    timeout : int
)

Parameters

  • timeout
    Specifies the number of milliseconds before failing the method. If zero, BeginInsertion tries to begin insertion mode, then returns the appropriate status immediately. If WaitForever, BeginInsertion tries to begin insertion mode, then waits as long as needed until either the form is inserted or an error occurs.

Remarks

When it is called, the slip station is made ready to receive a form by opening the form's handling "jaws" or starting a form insertion mode. BeginInsertion is paired with the EndInsertion method for controlling form insertion.

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

  • The form is successfully inserted. In this case, the service object returns Success.

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

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

Value

Description

Busy

Cannot perform while output is in progress.

Illegal

The slip station does not exist (see the CapSlpPresent property).

Timeout

The specified time has elapsed without the form being correctly inserted.

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
EndInsertion
BeginRemoval
EndRemoval