MagTek Excella STX99875340 - Manual (Page 34)

Excella Windows API Specifications
24
MTMICRGetIndexValue
MTMICRGetIndexValue function retrieves a key/value pair that was previously stored in the pcDocInfo parameter.
MTMICRGetIndexValue function is similar to the function MTMICRGetValue. MTMICRGetIndexValue function adds
index to the key name before searching for the value of the key name pcKey in the pcDocInfo
.
ULONG MTMICRGetIndexValue (
char
*pcDocInfo,
char * pcSection,
char *pcKey,
unsigned int nIndex,
char *pcValue,
DWORD *pdwLength
);
Parameters
pcDocInfo
Buffer pointer containing all the key/value pairs.
pcSection
Pointer to null terminated string containing the section name .
pcKey
Pointer to null terminated string containing the key name .
nIndex
Key Index Number
pcValue
Pointer to the buffer that receives the retrieved value .
pdwLength
Specifies the size of the buffer pointed to by the pcValue parameter .
Return Values
MICR_ST_OK
MICR_ST_NOT_ENOUGH_MEMORY
MICR_ST_ERR_LOAD_XML
MICR_ST_ERR_GET_DOM_POINTER
MICR_ST_BAD_DATA
MICR_ST_BAD_SECTION_NAME
MICR_ST_BAD_KEY_NAME
MICR_ST_BAD_VALUE_BUFFER
MICR_ST_BAD_BUFFER_LENGTH
MICR_ST_KEY_NOT_FOUND