All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDACut

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---VPMDesktopObjects.CATIAVPMVDACommand
            |
            +---CATIAVPMVDACut
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIAVPMVDACut

This interface cuts an object and puts it in the buffer.
Role : Instead of executing a copy paste on a Business Object, you can execute a cut first, a paste then. This command does the same thing as the copy command, and executes a cut of the object from its father object. The object is then put in the buffer for a later paste operation.


Method Index


o get_BObject(ENOVIABusinessObject*&)
This method gives access to the Business Object cut and put in the buffer, to perform some operations on it.
o get_ParentBObject(ENOVIABusinessObject*&)
This method gives access to the parent Business Object of the object cut and put in the buffer, to perform some operations on it.
o isResetReqd(int)
This method gives access to the Business Object to set Reset flag for the buffer, By Default the Buffer is reset.
o put_BObject(ENOVIABusinessObject*)
This method sets the Business Object to be cut and put in the buffer of the server for use for a later paste operation.
o put_ParentBObject(ENOVIABusinessObject*)
This method sets the parent Business Object of the object to cut, to remove the link between those two objects.

Methods


o get_BObject
public virtual HRESULT __stdcall get_BObject(ENOVIABusinessObject*& object)=0
This method gives access to the Business Object cut and put in the buffer, to perform some operations on it. It is designed for the user-exits for the customer, and should not be used in another context.
Parameters:
object
The cut Business Object.
Returns:
S_OK in case of success.
o get_ParentBObject
public virtual HRESULT __stdcall get_ParentBObject(ENOVIABusinessObject*& object)=0
This method gives access to the parent Business Object of the object cut and put in the buffer, to perform some operations on it. It is designed for the user-exits for the customer, and should not be used in another context.
Parameters:
object
The parent object of the cut Business Object.
Returns:
S_OK in case of success.
o isResetReqd
public virtual int isResetReqd(int i)=0
This method gives access to the Business Object to set Reset flag for the buffer, By Default the Buffer is reset. It is designed for the user-exits for the customer, and should not be used in another context.
Parameters:
i
other than 0 can be passed to reset the buffer.
Returns:
Always 0
o put_BObject
public virtual HRESULT __stdcall put_BObject(ENOVIABusinessObject* object)=0
This method sets the Business Object to be cut and put in the buffer of the server for use for a later paste operation.
Parameters:
object
The object to cut.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_ParentBObject
public virtual HRESULT __stdcall put_ParentBObject(ENOVIABusinessObject* object)=0
This method sets the parent Business Object of the object to cut, to remove the link between those two objects.
Parameters:
object
The parent object of the object to cut.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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