Interface to set the persistency mode for a product to be saved in ENOVIA V5 and its children.
Role:Enable to set the persistency mode for a product and optionally its children before to Save them in ENOVIA V5.
Parameters:
ipDoc
(input) The CATIA document to set its persistency mode.
iSaveMode
(input) The persistency mode for the document to be saved. Possible values are:
PermanentBlackBox: Product, Part or any other applicative document will be streamed in the Vault.
VolatileExposed: Product document will be saved and exposed in ENOVIA V5 VPM.
Values NotDefined and PermanentExposed are not accepted.
iPropagate
(input) Boolean flag to enable the persistency mode propagation on children documents. Possible values are:
TRUE: Propagation enable.
FALSE: Propagation unable.
Returns:
S_OK: Persistency mode successfully set on document and successfully propagated on children.
S_FALSE: VolatileExposed mode successfully set on document, but the children propagation has only been partially executed.
E_FAIL: Persistency Mode or persistency children propagation has failed. Possible errors may be:
The connection with the ENOVIA V5 Server isn't established.
The Document to be set is already persisted in ENOVIA V5.
The VolatileExposed mode isn’t supported on standalone CATProduct
The PermanentBlackBox mode can't be set on Document, because the VolatileExposed mode is set on one of its children.
The VolatileExposed mode can't be set on Document, because the PermanentBlackBox mode is set on one of its parents.
The VolatileExposed mode propagation can't be done, because a child of the document is already persisted as a PermanentBlackBox in EV5.
The PermanentBlackBox mode propagation can't be done, because a child of the document is already persisted as VolatileExposed in EV5.
An abnormal error happened while setting or propagting the VaultMode.
E_INVALIDARG: One or several arguments contain an improper value. Possible errors may be:
The [ipDoc] parameter is NULL or is not a CATDocument.
The [iSaveMode] parameter value is different from "PermanentBlackBox" and "VolatileExposed"
The [iSaveMode] parameter value is "VolatileExposed" whereas the [ipDoc] parameter isn't a "CATProduct" typed document.
This object is included in the file: CATPDMInteropServices.h