MagTek Excella Windows API99875313 - Manual (Page 28)

Excella Windows API Specifications
20
MTMICRSetIndexValue
MTMICRSetIndexValue is similar to the MTMICRSetVaue, except that, MTMICRSetIndexValue adds the
Index number to the pcKey before adding the key/value pair to the given Options buffer.
ULONG MTMICRSetIndexValue (
char *pcOptions,
char *pcSection,
char *pcKey,
unsigned int nIndex,
char *pcValue,
DWORD *pdwLength
);
Parameters
pcOptions
Pointer to null terminated string containing all key/value pairs.
pcSection
Pointer to null terminated string containing the section name.
pcKey
Pointer to null terminated string containing the key name.
nIndex
Index of the key.
pcValue
Pointer to null terminated string containing the key value.
pdwLength:
Pointer to a double word that contains the size of the pcOptions buffer.
Return Values
MICR_ST_OK
MICR_ST_NOT_ENOUGH_MEMORY
Remarks
The function returns MICR_ST_NOT_ENOUGH_MEMORY, if the memory allocated for pcOptions buffer is not
big enough to store the additional key/value pair. The required size for the buffer is returned in pdwLength;
The minimum size of the buffer should be equal to MTMICR_OPTIONS_BUFFER_SIZE.
The MTMICRSetIndexValue function saves the new key/value pair in the pcOptions buffer only. This function
does not send the new key/value pair to the device. Use function MTMICRProcessCheck to send this key/value
pair to the device.