3.8 WFS_INF_CDM_MIX_TABLE

Description This command is used to retrieve the house mix table specified by the mix number.

Input Param LPUSHORT lpusMixNumber;

lpusMixNumber
Points to the number of the requested house mix table.

Output Param LPWFSCDMMIXTABLE lpMixTable;

typedef struct _wfs_cdm_mix_table
{
USHORT usMixNumber;
LPSTR lpszName;
USHORT usRows;
USHORT usCols;
LPULONG lpulMixHeader;
LPWFSCDMMIXROW * lppMixRows;
} WFSCDMMIXTABLE, *LPWFSCDMMIXTABLE;

usMixNumber
Internal number of house mix table.

lpszName
Points to the name of the table.

usRows
Number of rows in the house mix table. There is at least one row for each distinct total amount to be denominated.

usCols
Number of columns in the house mix table. There is one column for each distinct bill and coin value included in the mix.

lpulMixHeader
Pointer to an array of length usCols of unsigned longs ; each element defines the value of the bill or coin corresponding to its respective column. (See WFS_INF_CDM_CURRENCY_EXP.)

lppMixRows
Pointer to an array (of length usRows) of pointers to WFSCDMMIXROW structures:

typedef struct _wfs_cdm_mix_row
{
ULONG ulAmount;
LPUSHORT lpusMixture;
} WFSCDMMIXROW, *LPWFSCDMMIXROW;

ulAmount
Amount denominated by this mix row (See WFS_INF_CDM_CURRENCY_EXP).

lpusMixture
Pointer to a mix row, an array of length usCols of unsigned integers; each element defines the quantity of each bill and coin denomination in the mix used in the denomination of ulAmount.

Error Codes The following additional error codes can be generated by this command:

Value Meaning

WFS_ERR_CDM_INVALIDMIXNUMBER The lpusMixNumber parameter does not correspond to a defined mix table.

Comments None.