IClientPaymentProvider::ManagePaymentInstance

IClientPaymentProvider::ManagePaymentInstance

Syntax

HRESULT ManagePaymentInstance(
BSTRbstrFriendName// in
long FAR *pcIdx// out
);

Description

The ManagePaymentInstance function allows the user to modify an instance in the CPC. This function identifies an instance by its friendly name and returns its index position to the caller.

When building the CPC, you may choose not to permit modifications to the friendly name of an instance. Note that IClientPaymentProvider::Exists should be called only when the friendly name has changed. If the friendly name has not changed, then you should not call the Exists function.

Parameters

bstrFriendName: Friendly name of the instance to modify.
pcIdx: Index to the newly modified payment instance.

Return Value

This function returns one of the following values.

Value	Meaning
E_VALIDARG	One or more of the arguments is invalid.
E_OUTOFMEMORY	Out of memory.
E_FAIL	Failure.
S_OK	Success.
S_FALSE	Cancel by user.

Remarks

During add and modify operations, the IWalletCallback::Exists function must be called to verify that no instance with the same friendly name exists across CPCs.