All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMDesktopObjects Interface CATIAVPMVDAImport

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


interface CATIAVPMVDAImport

Interface to the Generic Component Import utility.

Role:Defines the interfaces to methods to create new Generic Components from a template Generic Component.


Method Index


o get_Result(CATIAVPMGenericComponent_var&)
This method retrieves the newly created GCo.
o put_GCo(CATIAVPMGenericComponent_var&)
This method defines the template GCo which is used to create the new GCo in the input PRC.
o put_PRC(CATIAVPMProductRootClass_var&)
This method defines the PRC on which the new GCo will be created.
o put_Primary(short)
This method sets the flag to indicate whether the newly created GCo will be primary or not.

Methods


o get_Result
public virtual get_Result( newGCo)
This method retrieves the newly created GCo.
Parameters:
newGCo
The new GCo.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_GCo
public virtual put_GCo( const importGCo)
This method defines the template GCo which is used to create the new GCo in the input PRC.
Parameters:
importGCo
The template GCo used for create.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_PRC
public virtual put_PRC( const hPRC)
This method defines the PRC on which the new GCo will be created.
Parameters:
hPRC
The PRC to contain the new GCo.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_Primary
public virtual put_Primary( const iIsPrimary)
This method sets the flag to indicate whether the newly created GCo will be primary or not.
Parameters:
iIsPrimary
The primary flag.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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