Return value – MagTek MAGTEK User Manual
Page 68
MagTek Communications Protocol, Driver Reference Manual
62
Return Value
The returned value indicates the outcome of the get property function.
Value
Meaning
MCP_ST_OK
Success. The property value is located in the output buffer pointed
to by lpOutBuffer.
MCP_ST_NOT_FOU
ND
The property could not be found
MCP_ST_INVALID
Invalid device handle hDevice
MCP_ST_REFUSE
The data type does not match the expected data type.
MCP_ST_OVERFLO
W
The output buffer is not large enough to hold the returned value
MCP_ST_FAILED Other
error.
Remarks
The dwOperAttribute member is used to indicate whether the property is being accessed from
the MCP driver (MCP_ATTR_PROP_DRIVER) or MCP device applications
(MCP_ATTR_PROP_DEVICE). One or the other attributes must be indicated.
The MCP device applications identify properties only by numeric IDs due to the limited amount
of memory and processing power.
lpszPropertyName
must be set to null when accessing device
application properties. Refer to the device's Command Reference Manual for the available
property Ids, application Ids and their function.
The MCP driver properties can be specified by name only. See Device instance properties
section for a list of these.