Share via


CashChanger.PauseDeposit Method

2/27/2008

Suspends or resumes depositing cash.

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

Syntax

'Declaration
Public MustOverride Sub PauseDeposit ( _
    pauseAction As CashDepositPause _
)
public abstract void PauseDeposit (
    CashDepositPause pauseAction
)
public:
virtual void PauseDeposit (
    CashDepositPause pauseAction
) abstract
public abstract void PauseDeposit (
    CashDepositPause pauseAction
)
public abstract function PauseDeposit (
    pauseAction : CashDepositPause
)

Parameters

Remarks

PauseDeposit is used to suspend or resume depositing cash.

If pauseAction is Pause, the cash acceptance operation is paused. The deposit process remains paused until PauseDeposit is called by using pauseAction equal to Restart. You can call the FixDeposit method while cash acceptance is paused.

When the deposit process is paused, the DepositCounts and DepositAmount properties are updated to reflect the current state of the cash changer. The property values are not changed again until the deposit is resumed.

If pauseAction is Restart, the deposit process is resumed.

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

Value

Meaning

Illegal

One of the following errors occurred:

  • Cash acceptance is not supported.

  • The call sequence is incorrect. BeginDeposit must be called before the code calls PauseDeposit.

  • The deposit process is already paused and pauseAction is Pause, or the deposit process in not paused and pauseAction is Restart.

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

CashChanger Class
CashChanger Members
Microsoft.PointOfService Namespace
DepositCounts
DepositAmount
CapDepositDataEvent
CapPauseDeposit
CashChanger.BeginDeposit Method
CashChanger.EndDeposit Method
CashChanger.FixDeposit Method