All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Interface CATIOmbContainerLinksUpdateStatus

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

Usage: you can freely reimplement this interface.


interface CATIOmbContainerLinksUpdateStatus

This interface is dedicated to containers embedding features pointing to external documents.
This interface enables activation of an internal DS mechanism preventing GhostLinks generation. This interface will be called by the save mechanism on every containers (loaded or not) embedded in the document being saved.


Method Index


o NeedsToUpdateLinkForPointedRename(CATBoolean&)
Determines if the container has to be included in the DS mechanism against GhostLinks.

Methods


o NeedsToUpdateLinkForPointedRename
public virtual HRESULT NeedsToUpdateLinkForPointedRename(CATBoolean& oStatus) = 0
Determines if the container has to be included in the DS mechanism against GhostLinks. GhostLinks prevention may impact Save performances and is by default inactivated. In order to turn it on for a specific container, container has to implement this interface and set oStatus to TRUE.
if oStatus is set to TRUE, save mechanism will perform the following tasks
  • load non loaded container
  • apply the DS mechanism against GhostLinks on the container.
if oStatus is set to FALSE, save mechanism will perform the following tasks
  • no additional operation will be performed for the container.
Typical implementation will look like { oStatus=TRUE; return S_OK; }
Parameters:
[out]
oStatus
  • oStatus==TRUE : Container will be included in DS mechanism against GhostLinks
  • oStatus==FALSE : GhostLinks prevention will not be performed on the container.
Returns:
  • S_OK oStatus has been set with success
  • E_FAIL unexpected error. GhostLinks prevention will not be performed on the container.

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

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