All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface ENOVIWhereUsedInfo

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ENOVIWhereUsedInfo
 

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


interface ENOVIWhereUsedInfo

Interface to retrieve whereused information of an object.
Role: At the application level this interface provides a way to retrieve WhereUsed information for an object.


Method Index


o GetWhereUsedInfo(CATIVpmFactoryObject*,CATUnicodeString&,CATListOfCATIVpmFactoryObject&)
Method to get the whereused information.

Methods


o GetWhereUsedInfo
public virtual HRESULT GetWhereUsedInfo( const CATIVpmFactoryObject* iSelectedObject,
const CATUnicodeString& iWhereUsedType,
CATListOfCATIVpmFactoryObject& oWhereUsedList) = 0
Method to get the whereused information.
Parameters:
iSelectedObject
the object for which the where used information is being retrieved
iWhereUsedType
the string which represents the type of where used information that needs to be retrieved for e.g. "V_PV" to retrieve the part reference of an instance etc. Some of the possible values for the different objects can be obtained from the ENOVWhereUsedNavigator_en or ClausesList.properties files (choose the request_ values).
oWhereUsedList
the list of objects where the selected object has been used for the the given type of Where Used relation.
Returns:
An HResult value to be returned by the method.
Legal values:
S_OK
successful
E_FAIL
failure

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

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