ICreditCardOtherCard::GetMask

Syntax

HRESULT GetMask(
BSTRbstrType// in
LONG *expDate// out
BSTR *bstrMask// out
);

Description

The GetMask function returns a string containing the mask for a specified payment type. There is no default mask; therefore, if a zero (0) is returned, this is an error. A mask is required in order for a credit-card number to appear in the Add dialog box. A flag is also returned that indicates whether or not the card contains an expiration date.

Parameters

bstrType

String identifying the payment type.

expDate

Address where this function returns a flag indicating whether or not the card contains an expiration date. A value of one (1) indicates that an expiration date is supported; a value of zero (0) indicates that the card has no expiration date.

bstrMask

Address where this function returns a string for the mask associated with the payment type. The mask defines how the credit-card number is formatted in the dialog box of the client payment module. The mask may contain the following characters, separated by spaces or hyphens:

• a to require the entry of alphabetic characters only
• n to require the entry of numeric characters only
• x to require the entry of alphanumeric characters

Characters in the mask can be in uppercase or lowercase. The mask should not exceed 20 characters in length (excluding spaces).

If you specify constants for the mask, these are displayed in the dialog box presented to the consumer by the Payment Selector. Notice that, for purposes of transactions, these constants will not be posted as part of the consumer's card number ; instead, only the characters entered by the consumer are posted.

Return Value

This function returns one of the following values.