All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecRoutingItf Interface CATIEwrUipWireGroups

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

Usage: you can freely reimplement this interface.


interface CATIEwrUipWireGroups

Interface dedicated to wire groups.
Role: This interface is used to list the wire groups to route


Method Index


o ListWireGroups(CATListValCATUnicodeString*,CATListValCATUnicodeString*,CATULONG32&,CATEwrWireGroup*&)
Retrieves the list of wire groups for a given list of systems and a given list of criteria.

Methods


o ListWireGroups
public virtual HRESULT ListWireGroups( const CATListValCATUnicodeString* iListOfSystems,
const CATListValCATUnicodeString* iListOfCriteria,
CATULONG32& oWireGroupsCount,
CATEwrWireGroup*& oListOfWireGroups) = 0
Retrieves the list of wire groups for a given list of systems and a given list of criteria.
Parameters:
iListOfSystems
The list of systems.
iListOfCriteria
The list of criteria. This argument can be used to list the wire groups for a configuration (may be NULL).
oWireGroupsCount
The number of wire groups
oListOfWireGroups
The list of wire groups
Returns:
An HRESULT value.
Legal values:
S_OK
The wire groups have been retrieved.
E_FAIL
Error while retrieving the wire groups.

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

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