All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface ENOVISubscriberEvent

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ENOVISubscriberEvent
 

Usage: you can freely reimplement this interface.


interface ENOVISubscriberEvent

Class to subscribe easily to events , without knowledge of explicit CallBack Interfaces.
Role: a client has 2 ways to subscribe to emission of events , by implementing explicit event interfaces (EARLY mode) proposed by the Publishers, or to implement this generic interface (LATE mode). In that case, the information about the event must be decoded by the client in its implementation...


Method Index


o onKo(ENOVIEvent_var&,HRESULT&)
CallBack method when something was wrong for another subscriber.
o onReceive(ENOVIEvent_var&,HRESULT&)
Callback method to be implemented for subscription.

Methods


o onKo
public virtual HRESULT onKo( const ENOVIEvent_var& iEvent,
HRESULT& ioNotifyReturnCode)=0
CallBack method when something was wrong for another subscriber. Role: this method is called by the event manager when a next subscriber returns a failure code from it's callback method. In that case, all the previous subscribers are called on their onKo() method.
Parameters:
iEvent
the instance of event which is currently raised
ioNotifyReturnCode
the status of the onKo callback action
o onReceive
public virtual HRESULT onReceive( const ENOVIEvent_var& iEvent,
HRESULT& ioNotifyReturnCode)=0
Callback method to be implemented for subscription. Role: this method is called by the event manager for each subscriber which has implemented it, when an event is published.
Parameters:
iEvent
the instance of event which is currently raised.
ioNotifyReturnCode
the status of the callback action :
S_OK if the callback execution had no problem
E_FAIL if there was a problem
E_ACCESSDENIED if a veto is put on the event
it's a status on the event callback to be sent back to the publisher, it has not the same meaning than the return code which is related to the code execution...

This object is included in the file: ENOVISubscriberEvent.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.