Usage Notes

To be notified of OIA updates using this class, the application must perform the following steps:

  1. Define a class derived from ECLOIANotify.
  2. Implement the NotifyEvent method of the ECLOIANotify-derived class.
  3. Optionally implement other member functions of ECLOIANotify.
  4. Create an instance of the derived class.
  5. Register the instance with the ECLOIA::RegisterOIAEvent() method.

After registration is complete, updates to the OIA indicators will cause the NotifyEvent() method of the ECLOIANotify-derived class to be called.

Note that multiple OIA updates which occur in a short period of time may be aggregated into a single event notification.

An application can choose to provide its own constructor and destructor for the derived class. This can be useful if the application needs to store some instance-specific data in the class and pass that information as a parameter on the constructor.

If an error is detected during event registration, the NotifyError() member function is called with an ECLErr object. Events may or may not continue to be generated after an error. When event generation terminates (due to an error or some other reason) the NotifyStop() member function is called. The default implementation of NotifyError() will present a message box to the user showing the text of the error messages retrieved from the ECLErr object.

When event notification stops for any reason (error or a call the ECLOIA::UnregisterOIAEvent) the NotifyStop() member function is called. The default implementation of NotifyStop() does nothing.