All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Interface CATIContainer

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

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


interface CATIContainer

Interface to structure a document.


Method Index


o ListMembersHere(CATIdent,SEQUENCE(CATBaseUnknown_ptr)&)
Searches all objects implementing a specific interface into the container.

Methods


o ListMembersHere
public virtual CATLONG32 ListMembersHere( const CATIdent interfaceID,
SEQUENCE(CATBaseUnknown_ptr)& ioListObj)=0
Searches all objects implementing a specific interface into the container.

role:
This method searches all objects implementing a specified interface given in argument and fill the sequence with them. Each object contained in the returned sequence must be released after user.

example:
   CATIContainer* pCATIContainer = ... // we suppose that pointer is well initialized.
   SEQUENCE(CATBaseUnknown_ptr) ListObj;
   CATLONG32 NbObj = pCATIContainer->ListMembersHere("CATIexample", ListObj);
   for (int i=0; i < NbObj; i++)
   {
     CATIexample* pCATIexample = NULL;
     if (ListObj[i] && SUCCEEDED(ListObj[i]->QueryInterface(IID_CATIexample, (void**)&pCATIexample))
     {
       pCATIexample->Release();
       pCATIexample = NULL;
       ListObj[i]->Release();
       ListObj[i] = NULL;;
     }
   }
Parameters:
interfaceID
The name of the interface searched.
ioListObj
The list of all objects found that implement this interface. Each object of the list must be release.
Returns:
The number of objects found.

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

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