All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDAExpand

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

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


interface CATIAVPMVDAExpand

This interface is the base of every expand command.
Role : Every interface of a expand command derives from this base interface. It provides the basic functionnalities shared by all other expand commands : expand depth, expand mode, level of object expanded, result list.


Method Index


o get_Depth(long&)
This method gets the expand depth.
o get_InputLevel(long&)
This method gets the input object level.
o get_Result(long,ENOVIABusinessObject*&,long&)
This method gets the result object at given index position.
o get_ResultCount(long&)
This method gets the size of the result list.
o get_StepByStep(boolean&)
This method gets the expand mode.
o put_Depth(long)
This method puts the expand depth.
o put_InputLevel(long)
This method puts the input object level.
o put_StepByStep(boolean)
This method puts the expand mode (step by step or not).

Methods


o get_Depth
public virtual HRESULT __stdcall get_Depth(long& depth)=0
This method gets the expand depth.
Parameters:
depth.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_InputLevel
public virtual HRESULT __stdcall get_InputLevel(long& level)=0
This method gets the input object level.
Parameters:
level.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_Result
public virtual HRESULT __stdcall get_Result(long length,
ENOVIABusinessObject*& object,
long& depth)=0
This method gets the result object at given index position.
Parameters:
length
index of the object in the result list .
object
element at the position length of the result list .
depth
level of the element at the position length .
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ResultCount
public virtual HRESULT __stdcall get_ResultCount(long& length)=0
This method gets the size of the result list.
Parameters:
length.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_StepByStep
public virtual HRESULT __stdcall get_StepByStep(boolean& stepbystep)=0
This method gets the expand mode.
Parameters:
stepbystep.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_Depth
public virtual HRESULT __stdcall put_Depth(long depth)=0
This method puts the expand depth.
Parameters:
depth.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_InputLevel
public virtual HRESULT __stdcall put_InputLevel(long level)=0
This method puts the input object level.
Parameters:
level.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_StepByStep
public virtual HRESULT __stdcall put_StepByStep(boolean stepbystep)=0
This method puts the expand mode (step by step or not).
Parameters:
stepbystep
.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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