All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMDesktopObjects Interface CATIAVPMVDADelete
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---VPMDesktopObjects.CATIAVPMVDACommand
|
+---CATIAVPMVDADelete
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIAVPMVDADelete
This interface is used to delete an object.
Role : This interface deletes a Business Object from memory and from database
(effective at the next save) by calling the Remove() method on the object.
Method Index
- o
get_BObject(ENOVIABusinessObject*&)
- This method gets the object to delete.
- o
get_DeleteAllVersions(boolean&)
- This method gets the flag for deleting all versions of the object.
- o
get_DeleteReference(boolean&)
- This method gets the flag for deleting the reference of the object.
- o
put_BObject(ENOVIABusinessObject*)
- This method sets the Business Object to delete in the command.
- o
put_DeleteAllVersions(boolean)
- This method sets the flag for deleting all existing versions of the current object, if this object is versionnable.
- o
put_DeleteReference(boolean)
- This method sets the flag for deleting the reference of the object if it has one.
Methods
o get_BObject
-
This method gets the object to delete. It is designed for user-exit purposes and should not be used in another context.
- Parameters:
-
- object
- The object to delete.
- Returns:
- Always S_OK.
o get_DeleteAllVersions
-
This method gets the flag for deleting all versions of the object. It is designed for user-exit purposes and should not be used in another context.
- Parameters:
-
- DeleteAllVersions
- If true, all versions of the object will be deleted.
- Returns:
- Always S_OK.
o get_DeleteReference
-
This method gets the flag for deleting the reference of the object. It is designed for user-exit purposes and should not be used in another context.
- Parameters:
-
- DeleteReference
- If true, the reference of the object will be deleted.
- Returns:
- Always S_OK.
o put_BObject
-
This method sets the Business Object to delete in the command.
- Parameters:
-
- object
- The object to delete.
- Returns:
- Always S_OK.
o put_DeleteAllVersions
-
This method sets the flag for deleting all existing versions of the current object, if this object is versionnable.
- Parameters:
-
- DeleteAllVersions
- If true, all versions of the object will be deleted.
- Returns:
- Always S_OK.
o put_DeleteReference
-
This method sets the flag for deleting the reference of the object if it has one.
- Parameters:
-
- DeleteReference
- If true, the reference of the object will be deleted.
- Returns:
- Always S_OK.
This object is included in the file: CATIAVPMVDADelete.h
If needed, your Imakefile.mk should include the module: VPMVDOItf