Previous in Contents Next in Contents

IClientPaymentProvider::GetFriendlyName

Syntax

HRESULT GetFriendlyName(
longcIndex// in
BSTR FAR *RetName// out
);

Description

The GetFriendlyName function returns the friendly name for an instance based upon index position. Valid values of an index are zero through GetInstanceCount minus one.

Parameters

cIndex
Index of the payment instance in the list of instances registered with the CPC.
RetName
Pointer to the location where this function will return the friendly name of the payment instance at the specified index.

Return Value

This function returns one of the following values.

Value Meaning
S_OK Success.
E_INVALIDARG One or more of the arguments is invalid.
E_OUTOFMEMORY Out of memory.
E_FAIL Failure.


© 1997-2000 Microsoft Corporation. All rights reserved.