All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPDMBaseInterfaces Interface CATIPDMUESaveProcess

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

Usage: you can freely reimplement this interface.


interface CATIPDMUESaveProcess



Method Index


o BeforeCommit(CATLISTP(CATDocument)*,CATIPDMSaveInfo*,CATIPDMSaveAction*)
Method to implement user-exit before commit “Save in ENOVIA”.
o BeforeRollback(CATLISTP(CATDocument)*,CATIPDMSaveInfo*,CATIPDMSaveAction*)
Method to implement user-exit before Rollback ENOVIA session.
o BeforeSaveDialog(CATLISTP(CATDocument)*,CATIPDMSaveInfo*,CATIPDMSaveAction*)
Calls to the user exit occur at the following point in time BeforeSaveDialog : Before the save pannel is proposed to the user OnOK : When the OnOK is pressed by the user BeforeStartingSave : Before the save action is started OnSaveSucceeded : At successfull completion of the save action OnSaveFailed : At failure of the save action They have all the same signature:
o BeforeStartingSave(CATLISTP(CATDocument)*,CATIPDMSaveInfo*,CATIPDMSaveAction*)
Calls to the user exit occur at the following point in time BeforeStartingSave : Before the save action is started
o OnOK(CATLISTP(CATDocument)*,int,CATIPDMSaveInfo*,CATIPDMSaveAction*)
Calls to the user exit occur at the following point in time OnOK : When the OnOK is pressed by the user
o OnSaveFailed(CATLISTP(CATDocument)*,CATIPDMSaveInfo*,CATIPDMSaveAction*)
Calls to the user exit occur at the following point in time OnSaveFailed : At failure of the save action
o OnSaveSucceeded(CATLISTP(CATDocument)*,CATIPDMSaveInfo*,CATIPDMSaveAction*)
Calls to the user exit occur at the following point in time OnSaveSucceeded : At successfull completion of the save action

Methods


o BeforeCommit
public virtual HRESULT BeforeCommit(CATLISTP(CATDocument)* iDocsToSave,
CATIPDMSaveInfo* ipInfo,
CATIPDMSaveAction* ipAction) = 0
Method to implement user-exit before commit “Save in ENOVIA”.
Role: When implemented, this method will be called when Save process is completed successfully and before Commit the ENOVIA session.

Parameters:
iDocsToSave
(input) The list of documents involved in the Save process.
ipInfo
(input) The list of information related to the documents given in first parameter. * @param ipAction (input) The list of actions related to the documents given in first parameter.
Returns:
  • E_FAIL: Function has failed, and as consequence Rollback of the ENOVIA session will be performed. Notice also that in case user-exit BeforeRollback is implemented, it will be executed before actually rolling back the ENOVIA session (see BeforeRollBack).
  • Otherwise: Function is considered successfull, and hence Commit will be performed.
o BeforeRollback
public virtual HRESULT BeforeRollback(CATLISTP(CATDocument)* iDocsToSave,
CATIPDMSaveInfo* ipInfo,
CATIPDMSaveAction* ipAction) = 0
Method to implement user-exit before Rollback ENOVIA session.
Role: When implemented, this method will be called when Save process failed and before Rollback the ENOVIA session.

Parameters:
iDocsToSave
(input) The list of documents involved in the Save process.
ipInfo
(input) The list of information related to the documents given in first parameter. * @param ipAction (input) The list of actions related to the documents given in first parameter.
Returns:
: Whatever is the function returned code, the Rollback will be performed
o BeforeSaveDialog
public virtual HRESULT BeforeSaveDialog(CATLISTP(CATDocument)* iDocsToSave,
CATIPDMSaveInfo* ipInfo,
CATIPDMSaveAction* ipAction) = 0
Calls to the user exit occur at the following point in time BeforeSaveDialog : Before the save pannel is proposed to the user OnOK : When the OnOK is pressed by the user BeforeStartingSave : Before the save action is started OnSaveSucceeded : At successfull completion of the save action OnSaveFailed : At failure of the save action They have all the same signature:
Parameters:
iDocsToSave
List of documents that are being saved
ipInfo
Interface pointer to let the user exit acess information about the saving context. Refer to the intf definition for available info
ipAction
Interface pointer to let the user exit influence the save process Refer to the intf definition for available action
Returns:
S_OK: Success E_FAIL: Failure If returns from BeforeSaveDialog, OnOK, BeforeStartingSave interupt the save
o BeforeStartingSave
public virtual HRESULT BeforeStartingSave(CATLISTP(CATDocument)* iDocsToSave,
CATIPDMSaveInfo* ipInfo,
CATIPDMSaveAction* ipAction) = 0
Calls to the user exit occur at the following point in time BeforeStartingSave : Before the save action is started
o OnOK
public virtual HRESULT OnOK(CATLISTP(CATDocument)* iDocsToSave,
int onOKNumber,
CATIPDMSaveInfo* ipInfo,
CATIPDMSaveAction* ipAction) = 0
Calls to the user exit occur at the following point in time OnOK : When the OnOK is pressed by the user
o OnSaveFailed
public virtual HRESULT OnSaveFailed(CATLISTP(CATDocument)* iDocsToSave,
CATIPDMSaveInfo* ipInfo,
CATIPDMSaveAction* ipAction) = 0
Calls to the user exit occur at the following point in time OnSaveFailed : At failure of the save action
o OnSaveSucceeded
public virtual HRESULT OnSaveSucceeded(CATLISTP(CATDocument)* iDocsToSave,
CATIPDMSaveInfo* ipInfo,
CATIPDMSaveAction* ipAction) = 0
Calls to the user exit occur at the following point in time OnSaveSucceeded : At successfull completion of the save action

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

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