All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVInterfaces Interface ENOVIRBOList

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


interface ENOVIRBOList

Interface for ENOVIRBOList.
Role: This interfaces provides access methods to add and remove RBOs to current list of RBOs resolved by capture mode code implementations.


Method Index


o addRBOToRBOList(CATBaseUnknown_var&,CATUnicodeString&)
This method adds an object with a specified RBO type to the RBO list.
o addRBOsToRBOList(CATLISTV(CATBaseUnknown_var)&,CATListOfCATUnicodeString&)
This method adds a list of RBOs with specified RBO type to the RBO list.
o getListOfRBOTypes(CATListOfCATUnicodeString&)
This method returns a list of types of RBOs scheduled for extraction.
o getRBOsByType(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
This method returns a list of RBOs from the current RBO list scheduled to be extracted based on specified RBO type.
o removeRBOFromRBOList(CATBaseUnknown_var&,CATUnicodeString&)
This method allows removal of the RBO from the extraction list.

Methods


o addRBOToRBOList
public virtual addRBOToRBOList( const iRBO,
const iRBOType)
This method adds an object with a specified RBO type to the RBO list.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      iRBO
      The RBO
      iRBOType
      The RBO Type
o addRBOsToRBOList
public virtual addRBOsToRBOList( const iRBOs,
const iRBOTypes)
This method adds a list of RBOs with specified RBO type to the RBO list. Both input list lengths (length of lists for objects and RBO types) have to match.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      iRBOs
      The RBOs
      iRBOTypes
      The RBO Types
o getListOfRBOTypes
public virtual getListOfRBOTypes( oRBOTypes)
This method returns a list of types of RBOs scheduled for extraction.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      oRBOTypes
      The RBO types
o getRBOsByType
public virtual getRBOsByType( const iRBOType,
oRBOList)
This method returns a list of RBOs from the current RBO list scheduled to be extracted based on specified RBO type.
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      iRBOType
      The RBO type
      oRBOList
      The list of RBOs.
o removeRBOFromRBOList
public virtual removeRBOFromRBOList( const iRBO,
const iRBOType)
This method allows removal of the RBO from the extraction list. (RBO Type parameter is optional - all lists will be checked if it is not specified).
Returns:
Error codes
Legal values: as a HRESULT.
Main returns code used:
  • S_OK If operation runs well
  • S_FALSE In case of errors
  • E_FAILED In case of errors
      Parameters:
      iRBO
      The RBO
      iRBOType
      The RBO Type

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

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