All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface CATIDocRevEventListener

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

Usage: you can freely reimplement this interface.


interface CATIDocRevEventListener

Interface to events raised in Documents.

Role:Class to be implemented by a client who wants to subscribe to events raised in Documents.


Method Index


o onAfterNewDocReference(ENOVIEvent_var&,HRESULT&)
Method called when the event onAfterNewDocReference is emitted at step AFTER.
o onAfterNewDocRevision(ENOVIEvent_var&,HRESULT&)
Method called when the event onAfterNewDocRevision is emitted at step AFTER.
o onBeforeNewDocReference(ENOVIEvent_var&,HRESULT&)
Method called when the event onBeforeNewDocReference is emitted at step BEFORE.
o onBeforeNewDocRevision(ENOVIEvent_var&,HRESULT&)
Method called when the event onBeforeNewDocRevision is emitted at step BEFORE.
o onKo(ENOVIEvent_var&,HRESULT&)
Method called when the event onKo is emitted at step BEFORE.

Methods


o onAfterNewDocReference
public virtual HRESULT onAfterNewDocReference( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called when the event onAfterNewDocReference is emitted at step AFTER.
Role: to call back clients which subscribed to onAfterNewDocReference - step after - on the object. This step is emitted before creation of the login session is performed.
Parameters:
iRaisedEvent
the instance of event which is currently raised.
ioNotifyReturnCode
the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
See also:
ENOVIEvent
o onAfterNewDocRevision
public virtual HRESULT onAfterNewDocRevision( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called when the event onAfterNewDocRevision is emitted at step AFTER.
Role: to call back clients which subscribed to onAfterNewDocRevision - step after - on the object. This step is emitted before creation of the login session is performed.
Parameters:
iRaisedEvent
the instance of event which is currently raised.
ioNotifyReturnCode
the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
See also:
ENOVIEvent
o onBeforeNewDocReference
public virtual HRESULT onBeforeNewDocReference( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called when the event onBeforeNewDocReference is emitted at step BEFORE.
Role: to call back clients which subscribed to onBeforeNewDocReference - step before - on the object. This step is emitted before creation of the login session is performed.
Parameters:
iRaisedEvent
the instance of event which is currently raised.
ioNotifyReturnCode
the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
See also:
ENOVIEvent
o onBeforeNewDocRevision
public virtual HRESULT onBeforeNewDocRevision( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called when the event onBeforeNewDocRevision is emitted at step BEFORE.
Role: to call back clients which subscribed to onBeforeNewDocRevision - step before - on the object. This step is emitted before creation of the login session is performed.
Parameters:
iRaisedEvent
the instance of event which is currently raised.
ioNotifyReturnCode
the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
See also:
ENOVIEvent
o onKo
public virtual HRESULT onKo( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called when the event onKo is emitted at step BEFORE.
Role: to call back clients which subscribed to onKo - step before - on the object. This step is emitted before creation of the login session is performed.
Parameters:
iRaisedEvent
the instance of event which is currently raised.
ioNotifyReturnCode
the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
See also:
ENOVIEvent

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

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