All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface CATIEnovCatalogManager

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---VPMInterfaces.CATIAVPMTPRootDesktop
        |
        +---CATIEnovCatalogManager
 

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


interface CATIEnovCatalogManager

Interface for ENOVCatalogSupport implementation.

Role: This class provides methods to Navigate/update ENOVIA Catalog Structure.

Deprecated:
V5R17 -- Catalog is totally removed from LCA


Method Index


o ENOVCatalogGetChildren(CATBaseUnknown_var,CATLISTV(CATBaseUnknown_var)&)
o ENOVCatalogGetRootChapters(CATLISTV(CATBaseUnknown_var)&)
o ENOVCatalogObject(CATBaseUnknown_var,CATLISTV(CATBaseUnknown_var))
o ENOVCatalogQueryForChapters(CATUnicodeString,CATUnicodeString,CATLISTV(CATBaseUnknown_var)&)
o ENOVCatalogSetKeywordValue(CATBaseUnknown_var,CATUnicodeString,CATUnicodeString)
o ENOVCatalogSetKeywordValues(CATBaseUnknown_var,CATListOfCATUnicodeString,CATListOfCATUnicodeString)

Methods


o ENOVCatalogGetChildren
public virtual HRESULT ENOVCatalogGetChildren(CATBaseUnknown_var unkn_iChapter,
CATLISTV(CATBaseUnknown_var)& oResults)= 0
Deprecated:
V5R17 -- Catalog is totally removed from LCA Retrieves the child chapters and other objects catalogued under the chapter.
Parameters:
iChapter.
Input parameter - The parent chapter.
oResults.
Return parameter - List of Catalog chapter objects and other catalogued objects.
Returns:
S_OK in case of success, E_FAIL in case of error.
o ENOVCatalogGetRootChapters
public virtual HRESULT ENOVCatalogGetRootChapters(CATLISTV(CATBaseUnknown_var)& oResults)= 0
Deprecated:
V5R17 -- Catalog is totally removed from LCA Retrieves the ENOVIA root level catalog chapters.
Parameters:
oResults.
List of Catalog chapter objects returned.
Returns:
S_OK in case of success, E_FAIL in case of error.
o ENOVCatalogObject
public virtual HRESULT ENOVCatalogObject(CATBaseUnknown_var unkn_iChapter,
const CATLISTV(CATBaseUnknown_var) iObjectList)=0
Deprecated:
V5R17 -- Catalog is totally removed from LCA Catalogs the object (for e.g Part reference) to the input Chapters.
Parameters:
iChapter.
Input parameter - The parent chapter.
iObjectList.
Input parameter - List of objects to be Catalogued.
Returns:
S_OK in case of success, E_FAIL in case of error.
o ENOVCatalogQueryForChapters
public virtual HRESULT ENOVCatalogQueryForChapters(CATUnicodeString iChapterName,
CATUnicodeString iQueryMode,
CATLISTV(CATBaseUnknown_var)& oResults)= 0
Deprecated:
V5R17 -- Catalog is totally removed from LCA Retrieves the ENOVIA catalog chapters by Name and Filter Mode.
Parameters:
iChapterName.
Input name of the chapter to be retrieved.
iQueryMode.
Query type can be two types "Filter" or "Search". Use Filter option to get the chapters. Use Search option to get attached objects.
oResults.
List of Catalog chapter objects returned.
Returns:
S_OK in case of success, E_FAIL in case of error.
o ENOVCatalogSetKeywordValue
public virtual HRESULT ENOVCatalogSetKeywordValue(CATBaseUnknown_var unkn_iDescription,
CATUnicodeString iKeywordName,
CATUnicodeString iKeywordValue)=0
Deprecated:
V5R17 -- Catalog is totally removed from LCA Sets a single Keyword value on the input description object.
Parameters:
iDescripton.
Input parameter - input Catalog Description object.
iKeywordName.
Input parameter - Name of the keyword.
iKeywordValue.
Input parameter - Value of the keyword.
Returns:
S_OK in case of success, E_FAIL in case of error.
o ENOVCatalogSetKeywordValues
public virtual HRESULT ENOVCatalogSetKeywordValues(CATBaseUnknown_var unkn_iDescription,
CATListOfCATUnicodeString iKeywordNameList,
CATListOfCATUnicodeString iKeywordValueList)=0
Deprecated:
V5R17 -- Catalog is totally removed from LCA Sets the Keyword values on the input description object.
Parameters:
iDescripton.
Input parameter - input Catalog Description object.
iKeywordNameList.
Input parameter - List of keyword names.
iKeywordValueList.
Input parameter - List of keyword values.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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