MagTek OMTD 99875144 - Manual (Page 20)

OMTD OPOS for MagTek Devices
14
void ErrorEvent (LONG ResultCode, LONG ResultCodeExtended,
LONG ErrorLocus, LONG *pErrorResponse)
Fired when an error is detected and the Control’s State transitions into the error state.
void OutputCompleteEvent (LONG OutputID)
Fired when a previously started asynchronous output request completes successfully. The
OutputID parameter indicates the ID number of the asynchronous output request that is
complete.
void StatusUpdateEvent (LONG Status)
Fired when a Control needs to alert the application of a device status change. The Status
parameter is for device class-specific data, describing the type of status change. When a device
is enabled, the Control may fire initial StatusUpdateEvents to inform the application of the
device state.
Common Properties
The following properties are common to all OMTD control objects. Most properties are
initialized to their default values after a successful call to the Open method. If a property has not
been initialized, its default value will be “[Error]” for BSTR properties, 0 for numeric properties
and FALSE for Boolean properties. See the OPOS Specification for more information.
It is the application’s responsibility to determine what properties the CO supports by querying
the corresponding capability (e.g. CapXXX) property. If an unsupported property is accessed
that does not have a corresponding capability property, the return status will be
OPOS_E_ILLEGAL.
Property Name Access Type Description
AutoDisable R/W BOOL Set to TRUE if application wants to receive and process
only one input at a time. The default is FALSE.
BinaryConversion R/W LONG Format in which characters are placed into BString
arguments. The default is OPOS_BC_NONE.
CapPowerReporting R LONG Identifies the reporting capabilities of the device.
CheckHealthText R BSTR Holds the results of the most recent call to the
CheckHealth method.
Claimed R BOOL If TRUE, the device is claimed for exclusive access.
The device must be claimed before accessing the
device methods and properties and before events are
fired to the application. The default is FALSE.
ControlObjectDescription R BSTR String identifying the CO and the company that
produced it (e.g., “MSR OPOS Control, © 1999 MagTek,
Inc.”).
ControlObjectVersion R LONG Control object version number.