MagTek IMAGESAFE99875500 - Manual (Page 34)

ImageSafe Windows API Specifications
26
MTMICRGetSectionName
MTMICRGetSectionName function returns the name of the section which has the section number given in variable
dwSectionNumber. MTMICRGetSectionName parses through the buffer pcData containing a set of key/value pairs which
was previously stored in the buffer by using function MTMICRSetValue or function MTMICRSetIndexValue.
ULONG MTMICRGetSectionName (
char *pcData,
DWORD dwSectionNumber,
char *pcSectionName,
DWORD *pdwSectionNameSize
);
Parameters
pcData
Pointer to null terminated string containing a set of key/value pairs. .
dwSectionNumber
The section number of the section requesting for name.
pcSectionName
Pointer to a buffer uses to store the section name.
pdwSectionNameSize
Pointer to a variable that specifies the size, in bytes, of the buffer pointed to by the pcSectionName parameter. When the
function returns, this variable contains the size of the data copied to pcSectionName. If the buffer specified by
pcSectionName parameter is not large enough to hold the data, the function returns the value
MICR_ST_NOT_ENOUGH_MEMORY, and stores the required buffer size, in bytes, into the variable pointed to by
pdwSectionNameSize.
Return Values
MICR_ST_OK
MICR_ST_ERR_GET_DOM_POINTER
MICR_ST_ERR_LOAD_XML
MICR_ST_SECTION_NOT_FOUND
MICR_ST_BAD_DATA
MICR_ST_BAD_BUFFER_LENGTH
MICR_ST_BAD_SECTION_NAME
MICR_ST_NOT_ENOUGH_MEMORY
Remarks
If the function succeeds MICR_ST_OK is returned.
If pdwSectionNameSize is NULL, error MICR_ST_BAD_BUFFER_LENGTH is returned.
If the value of pdwSectionNameSize is not big enough to hold the name of requested section,
MICR_ST_NOT_ENOUGH_MEMORY is returned.
If pcData is NULL, MICR_ST_BAD_DATA is returned.
If data in pcData string is not in XML format, MICR_ST_ERR_LOAD_XML is returned.
If there is problem using MSXML, MICR_ST_ERR_GET_DOM_POINTER is returned.