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

Page 42: Remarks, Example

Advertising
background image

Excella Windows API Specifications


34

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

Remarks


If the function succeeds MICR_ST_OK is returned.

Example

char Settings [4096];
char DocInfo [4096];
char device[4096] ="";
DWORD SettingsBufferSize;
DWORD DocInfoSize;
char cValue [1024];
DWORD valueSize;

Advertising