All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIUpdateEvent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIUpdateEvent
Usage: you can freely reimplement this interface.
interface ENOVIUpdateEvent
Class to be implemented by a client who wants to subscribe to an event "Update" raised by any kind of object.
Role: the Subscriber gives a pointer on the implementation of this interface to subscribe.
Method Index
- o
onAfterUpdate(ENOVIEvent_var&,HRESULT&)
- method called after the "Update" method was executed , and implemented by each subscriber
Role: this method is called by the event manager
for each subscriber which has implemented it, when a method update was executed
- o
onBeforeUpdate(ENOVIEvent_var&,HRESULT&)
- method called before the "Update" method is executed , and implemented by each subscriber
Role: this method is called by the event manager
for each subscriber which has implemented it, when an event "Update"
is about to be published.
- o
onKo(ENOVIEvent_var&,HRESULT&)
- Method called when something failed after Call of onBeforeUpdate or onAfterUpdate
Role: when a N-th subscriber returns a failure code, the 1st .
Methods
o onAfterUpdate
public virtual HRESULT onAfterUpdate( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
method called after the "Update" method was executed , and implemented by each subscriber
Role: this method is called by the event manager
for each subscriber which has implemented it, when a method update was executed
- 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...
o onBeforeUpdate
public virtual HRESULT onBeforeUpdate( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
method called before the "Update" method is executed , and implemented by each subscriber
Role: this method is called by the event manager
for each subscriber which has implemented it, when an event "Update"
is about to be 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...
o onKo
public virtual HRESULT onKo( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called when something failed after Call of onBeforeUpdate or onAfterUpdate
Role: when a N-th subscriber returns a failure code, the 1st ... N-1 th subscribers
are warned that something was wrong...
- Parameters:
-
- iEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status of the last callback action :
E_FAIL if there was a problem
E_ACCESSDENIED if a veto was put on the event
This object is included in the file: ENOVIUpdateEvent.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces