IClientPaymentProvider::GetBitmap

Syntax

HRESULT GetBitmap(
longcFriendIdx// in
longfType// in
long *hBitMap// out
);

Description

The GetBitmap function returns a bitmap handle based upon an index of an instance. Large (120 × 79, 16–system color) and small (30 × 18, 16–system color) bitmaps are defined or supported. It is valid to return zero if a bitmap does not exist. Note that this function will not return an E_OUTOFMEMORY value because bitmaps are created during the Create call (which may return an E_OUTOFMEMORY value).

Parameters

cFriendIdx

Index into the list of payment instances for the CPC.

fType

Enumerated type indicating whether the small or large bitmap should be returned.

hBitMap

Pointer to the location where this method returns a handle to a bitmap that is used with the friendly name to represent the payment instance.

Return Value

This function returns one of the following values.