beautypg.com

Mtmicrgetvalue, Parameters, Return values – MagTek Excella Windows API99875313 User Manual

Page 30: Remarks, Example

background image

Excella Windows API Specifications


22

MTMICRGetValue

MTMICRGetValue

function retrieves a key/value pair that was previously stored in the pcDocInfo parameter

using MTMICRSetValue function

ULONG MTMICRGetValue (
char

*pcDocInfo,

char

*pcSection,

char

*pcKey,

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.

pcValue

Pointer to the buffer that receives the retrieved string.

pdwLength

Specifies the size of the pcValue buffer.

Return Values


MICR_ST_OK
MICR_ST_NOT_ENOUGH_MEMORY
MICR_ST_BAD_PARAMETER
MICR_ST_ERR_LOAD_XML
MICR_ST_ERR_GET_DOM_POINTER

Remarks


MTMICRGetValue finds the key in the pcDocInfo buffer then returns its value in the pcValue.
If MTMICRGetValue succeeds it returns MICR_ST_OK.
If pdwLength is less than the size of the returned value then MICR_ST_NOT_ENOUGH_MEMORY is returned
and the required size for the pcValue buffer is returned in the pdwLength.
If the key/value pair can not be found, then a NULL is returned for pcValue and error parameter
MICR_ST_BAD_PARAMETER is returned.