All Frameworks Class Hierarchy This Framework Indexes
ProductStructureInterfaces Interface CATIPrdHandleImpactsOnInstance
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPrdHandleImpactsOnInstance
Interface to rename a Product Instance and manage the impacts.
Role : By using this interface for renaming a product instance,
impacted elements pointing this instance will be reconnected.
Warnings :
Only pointing objects loaded in the session will be reconnected.
This interface is implemented on ASMProduct Instances only.
Implementation is only avalaible under PX1 license.
Method Index
- o
RenameInstance(CATUnicodeString)
- Renames a Product Instance and reconnect pointing elements.
Methods
o RenameInstance
| public virtual RenameInstance( | const | iNewName) |
-
Renames a Product Instance and reconnect pointing elements.
Role: This method renames the product instance and changes
automatically the paths of pointing objects loaded in session.
- Parameters:
-
- iNewName
- The new name of the product instance
- Returns:
- The possible return values are :
- E_FAIL: the new name is not set on instance successfully.
because it is not valid :
- forbidden char : "!", ":", "<", ">"
- not valuated
- starts with an empty char : " "
- S_OK: the new name is set on instance successfully
and all pointing elements are reconnected.
This object is included in the file: CATIPrdHandleImpactsOnInstance.h
If needed, your Imakefile.mk should include the module: CATProductStructureInterfaces