MagTek Excella Windows API99875313 - Manual (Page 26)

Excella Windows API Specifications
18
MTMICRSetValue
MTMICRSetValue function adds a key/value pair to the given device settings specified in pcOptions buffer and in
a given section specified in pcSection buffer.
ULONG MTMICRSetValue (
char *pcOptions,
char *pcSection,
char *pcKey,
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.
pcValue
Pointer to null terminated string containing the key value. If this is NULL, then the key pcKey is deleted from
the section pcSection.
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 functions return MICR_ST_NOT_ENOUGH_MEMORY, if the pcOptions buffer is not enough to add the new
key/value pair. The required size of the buffer is returned in pdwLength.
The minimum size of the buffer should be equal to MTMICR_OPTIONS_BUFFER_SIZE.
The MTMICRSetValue function saves the new key/value pair in the pcOptions buffer only. This function does not
send this key/value pair to the device. Use function MTMICRProcessCheck to send this key/value pair to the
device.