All Frameworks Class Hierarchy This Framework Indexes
CDMAInteroperability Interface CATIPDMUEPrePostProcessSave
Usage: you can freely reimplement this interface.
interface CATIPDMUEPrePostProcessSave
Interface to enable the user to forbid the save of certain documents and to know which documents have been saved in VPM.
The method PreProcess is called just before sending the objects to save to VPM.
The method PostProcess is called just after the save in VPM is finished and CATIA got the feedback from VPM.
Role: This interface is a user exit allowing a user to forbid the save of certain documents and to know which documents have well been saved.
You should implement it on the CATUEPDMPrePostProcessSave component as implement class.
Method Index
- o
PostProcess(CATLISTP(CATDocument)*)
- Allows the user to know which documents have been saved in VPM.
- o
PreProcess(CATLISTP(CATDocument)*,CATLISTP(CATDocument)*&)
- Allows the user to forbid the save of certain documents.
Methods
o PostProcess
| public virtual PostProcess( | | iListOfSavedDocuments) |
-
Allows the user to know which documents have been saved in VPM.
Role: This method allows the user to know which documents have been saved in VPM.
- Parameters:
-
- iListOfSavedDocuments
- The list of documents which have been saved in VPM.
- Returns:
-
- S_OK: execution successful
- E_FAIL: The method has failed.
o PreProcess
| public virtual PreProcess( | | iListOfDocumentsToSave, |
| | oListOfForbiddenDocuments) |
-
Allows the user to forbid the save of certain documents.
Role: This method allows the user to forbid the save of certain documents.
- Parameters:
-
- iListOfDocumentsToSave
- The list of documents that should be saved.
- oListOfForbiddenDocuments
- The list of documents the user wants to forbid the save:
- Returns:
-
- S_OK: execution successful
- E_FAIL: a problem occured in the user exit.
This object is included in the file: CATIPDMUEPrePostProcessSave.h
If needed, your Imakefile.mk should include the module: CATCinDocument