Magtek EXPRESSCARD 1000, Programming Reference Manual

Page: 30 / 33

ExpressCard 1000 Programming Reference
MTECSDK_GetAttribute
MTECSDK_GetAttribute function retrieves a key/value pair that was previously stored in the pcDocInfo parameter using
MTECSDK_SetAttribute function
ULONG MTECSDK_GetAttribute (
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 pcAttribute buffer.
Return Values
EC_ST_OK
EC_ST_NOT_ENOUGH_MEMORY
EC_ST_ERR_LOAD_XML
EC_ST_ERR_GET_DOM_POINTER
EC_ST_BAD_DATA
EC_ST_BAD_SECTION_NAME
EC_ST_BAD_KEY_NAME
EC_ST_BAD_VALUE_BUFFER
EC_ST_BAD_BUFFER_LENGTH
EC_ST_KEY_NOT_FOUND
Remarks
MTECSDK_GetAttribute finds the key in the pcDocInfo buffer then returns its value in the pcValue.
If MTECSDK_GetAttribute succeeds it returns EC_ST_OK.
If pdwLength is less than the size of the returned value then EC_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
EC_ST_KEY_NOT_FOUND is returned.
24