All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPDMBaseInterfaces Interface CATIPDMSaveInfo
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPDMSaveInfo
Usage: you can freely reimplement this interface.
interface CATIPDMSaveInfo
Method Index
- o
DocumentExistInPDM(CATUnicodeString&)
- Returns if a document of the passed in name already exists in the targeted PDM for save
- o
GetDocEnvironmentType(CATDocument*,CATUnicodeString&)
- Returns the doc env late type of the passed in document, typically File, VPM1, ENOVIA5
- o
GetModificationStatus(CATDocument*,ModifStatus&)
- Method to get the modifcation status related to a document involved in “Save in ENOVIA” command.
Enumerated Type Index
- o
ModifStatus
-
Methods
o DocumentExistInPDM
-
Returns if a document of the passed in name already exists in the targeted PDM for save
- Parameters:
-
- iDocName
- Document name to test for existence
- Returns:
- S_OK : A document of that name already exists in the PDM
S_FALSE : No document of that name already exits in the PDM
E_FAIL : Failure
o GetDocEnvironmentType
-
Returns the doc env late type of the passed in document, typically File, VPM1, ENOVIA5
- Parameters:
-
- iDoc
- The document to get doc environment
- oEnvType
- The returned late type of its doc environment
- Returns:
- S_OK: Success
E_FAIL: Failure
o GetModificationStatus
-
Method to get the modifcation status related to a document involved in “Save in ENOVIA” command.
- Parameters:
-
- iDocToSave
- (input) The document to check at Save.
- oStatus
- (output) The status which can be of the following values:
- PDM_NotDefined Document is not a workpackage (saved or to be saved as exploded document).
- PDM_New: Document is newly created in CATIA and has to be saved as a workpackage.
- PDM_Modified: Document already exists in ENOVIA and is modified in CATIA session.
- PDM_NotModified: Document already exists in ENOVIA and is NOT modified in CATIA session.
- Returns:
-
- S_OK: Function executed successfully
- E_FAIL: Error occurred during execution
Enumerated Types
o ModifStatus
-
enum ModifStatus {
PDM_NotDefined,
PDM_NotModified,
PDM_Modified,
PDM_New
}
This object is included in the file: CATIPDMSaveInfo.h
If needed, your Imakefile.mk should include the module: CATPDMBaseItf