Micr.BeginInsertion Method (POS for .NET v1.14 SDK Documentation)

3/2/2014

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

Remarks

When it is called, the MICR is made ready to receive a check by opening the MICR's check handling "jaws" or starting a MICR's check Insertion mode. BeginInsertion is paired with the EndInsertion method for controlling check insertion. For MICR devices that do not require this kind of processing, the BeginInsertion and EndInsertion 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 in Insertion mode, an error is returned to the application. Otherwise, the service object continues to monitor check insertion until either:

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

-Or-

• The check is not inserted 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 Insertion mode. This allows an application to perform some user interaction and reissue the BeginInsertion method without altering the MICR check handling mechanism.

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

Value	Meaning
Busy	If the MICR is a combination device, the peer device may be Busy.
Illegal	An invalid timeout parameter was specified.
Timeout	The specified time has elapsed without the check 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

Micr Class
Micr Members
Microsoft.PointOfService Namespace
EndInsertion
BeginRemoval
EndRemoval