All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMDesktopObjects Interface CATIAVPMVDANewVersion
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---VPMDesktopObjects.CATIAVPMVDACommand
|
+---CATIAVPMVDANewVersion
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIAVPMVDANewVersion
Interface to build a new version of a versionnable Business Object.
Role : Some business objects are versionnable, like the Part Instance,
the Part Reference, the Document, which means that they have an attribute
keeping their version. This command creates a new version of the object.
Method Index
- o
get_BOOldVersion(ENOVIABusinessObject*&)
- Gets the former object before versionning it.
- o
get_BObject(ENOVIABusinessObject*&)
- Gets the object to version.
- o
get_ID(CATUnicodeString&)
- Gets the value of the new identifier of the new object to create.
- o
get_PartFrom(ENOVIABusinessObject*&)
- Gets the Part Reference the new object version inherites from.
- o
get_Version(CATUnicodeString&)
- Gets the value of the new version to give to the new object to create.
- o
put_BObject(ENOVIABusinessObject*)
- Sets the object to version.
- o
put_ID(CATUnicodeString&)
- Sets the new identifier of the new object to create.
- o
put_PartFrom(ENOVIABusinessObject*)
- Allows to version an object by inheritance from another one.
- o
put_Version(CATUnicodeString&)
- Sets the value of the new version to give to the new object to create.
Methods
o get_BOOldVersion
-
Gets the former object before versionning it.
- Parameters:
-
- oObject
- The former object.
- Returns:
- Always S_OK.
o get_BObject
-
Gets the object to version. It is designed for user-exit for customer, and should not be used in another context.
- Parameters:
-
- oObject
- The object to version.
- Returns:
- Always S_OK.
o get_ID
-
Gets the value of the new identifier of the new object to create. It is designed for user-exit for customer and should not be used in another context.
- Parameters:
-
- iPartNumber
- The new identifier.
- Returns:
- Always S_OK.
o get_PartFrom
-
Gets the Part Reference the new object version inherites from. It is designed for user-exit for customer, and should not be used in another context.
- Parameters:
-
- oReference
- The Part Reference the new object version inherites from.
- Returns:
- Always S_OK.
o get_Version
-
Gets the value of the new version to give to the new object to create. It is designed for user-exit for customer and should not be used in another context.
- Parameters:
-
- oVersion
- The value of the new version.
- Returns:
- Always S_OK.
o put_BObject
-
Sets the object to version.
- Parameters:
-
- iObject
- The object to deal with.
- Returns:
- S_OK in case of success, S_FALSE if the object is locked by someone else,
other code if the object is not versionnable or in case of error.
o put_ID
-
Sets the new identifier of the new object to create. If it is not null, a new reference is created. If it is null, the previous reference is just
versionned.
- Parameters:
-
- iPartNumber
- The new identifier.
- Returns:
- Always S_OK.
o put_PartFrom
-
Allows to version an object by inheritance from another one.
- Parameters:
-
- iReference
- The Part Reference the new object version inherites from.
- Returns:
- Always S_OK.
o put_Version
-
Sets the value of the new version to give to the new object to create. This value can be null, then the value will be given
by default (--A, --B, then --C, etc...).
- Parameters:
-
- iVersion
- The value of the new version.
- Returns:
- Always S_OK.
This object is included in the file: CATIAVPMVDANewVersion.h
If needed, your Imakefile.mk should include the module: VDO0Commands