Share via


CashChanger.EndDeposit Method

Completes cash acceptance.

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

Usage

'Usage
Dim successAction As CashDepositAction
Dim cashChanger1 As CashChanger
cashChanger1.EndDeposit(successAction)

Syntax

'Declaration
Public MustOverride Sub EndDeposit( _
    ByVal successAction As CashDepositAction _
)
public abstract void EndDeposit(
    CashDepositAction successAction
);
public: abstract Void EndDeposit(
    CashDepositAction^ successAction
);
public abstract void EndDeposit(
    CashDepositAction successAction
);
public abstract function EndDeposit(
     successAction : CashDepositAction
) : Void;

Parameters

  • successAction
    A CashDepositAction enumeration.

Remarks

Contains the value of how to deal with the cash that was deposited and is established by the successAction parameter.

Before calling this method, the application must calculate the difference between the amount of the deposit and the amount required. If the deposited amount was greater than the amount required, use Change as the successAction parameter. If the deposited amount was equal to or less than the amount required, use NoChange as the successAction parameter.

If successAction is Repay, the deposit is repaid through either the cash deposit exit or the cash payment exit without storing the actual deposited cash.

The application must call FixDeposit before calling EndDeposit.

EndDeposit returns void if successful, and can throw the following exception:

Value

Meaning

Illegal

One of the following errors occurred:

  • Cash acceptance is not supported.

  • The call sequence is not correct. BeginDeposit and FixDeposit must be called in sequence before calling this method.

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.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

See Also

Reference

CashChanger Class
CashChanger Members
Microsoft.PointOfService Namespace
DepositCounts
DepositAmount
CapDepositDataEvent
BeginDeposit
FixDeposit
PauseDeposit