Example, Mtmicrsetindexvalue, Parameters – MagTek Excella STX99875340 User Manual

Page 31: Return values

Advertising
background image

Section 3. Excella API

21

Example


char Settings [4096];
DWORD SettingsBufferSize;

// Initialize Settings

// Initialize the Settings variable first
SettingsBufferSize =4096;

// Set a value of “4” to the key “Number” in section “ImageOptions”and store this new
key/value pair in the buffer” Settings”
dwStatus=MTMICRSetValue(Settings, "ImageOptions","Number","4", & SettingsBufferSize);

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
MICR_ST_BAD_PARAMETER
MICR_ST_BAD_DATA
MICR_ST_BAD_SECTION_NAME
MICR_ST_BAD_KEY_NAME
MICR_ST_BAD_VALUE_BUFFER
MICR_ST_BAD_BUFFER_LENGTH

Advertising