APPENDIX D: THE EVENT OBJECT

This appendix describes the use of the Event Object.
Note: All methods return an HRESULT. In the event of an error, CMO reports the error in the form of COM-compatible error objects. See Error Handling

D.1: Event Object
D.1.1: Overview
The EventObj allows an application program to be event-driven by having a procedure called when an event occurs in the amplifier. This allows the application program to continue execution while waiting for an event to occur. That is, the program is not blocked. For example, EventObj could call a procedure when a move is done, to perform some action such as performing the next move. The
Event Object can be set up to perform a callback on a one-time basis or repeatedly. The EventObj is used in conjunction with the CMO objects that support events: AmpObj, LinkageObj, and IOObj.
The CreateEvent method associated with each these three objects sets up the event monitor and returns an instance of the EventObj. See the following descriptions: 

D.1.2: Event Object Methods
All of the Methods described here are members of CMLCOMLib.EventObj

D.1.3: Callback Method
EventNotify is a member of CMLCOMLib.EventObj

D.1.4: Event Conditions
Each of the following is a member of CMLCOMLib.CML_EVENT_CONDITION. Used to select the event triggering condition.