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
public virtual HRESULT __stdcall get_BObject(ENOVIABusinessObject*& object)=0
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
public virtual HRESULT __stdcall get_DeleteAllVersions(boolean& DeleteAllVersions)=0
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
public virtual HRESULT __stdcall get_DeleteReference(boolean& DeleteReference)=0
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
public virtual HRESULT __stdcall put_BObject(ENOVIABusinessObject* object)=0
This method sets the Business Object to delete in the command.
Parameters:
object
The object to delete.
Returns:
Always S_OK.
o put_DeleteAllVersions
public virtual HRESULT __stdcall put_DeleteAllVersions(boolean DeleteAllVersions)=0
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
public virtual HRESULT __stdcall put_DeleteReference(boolean DeleteReference)=0
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

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