All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ElecRoutingItf Interface CATIEwrUipWires

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

Usage: you can freely reimplement this interface.


interface CATIEwrUipWires

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


Method Index


o ListWires(CATListValCATUnicodeString*,CATListValCATUnicodeString*,CATLONG32&,CATEwrWire*&)
Retrieves the list of wires for a given list of systems and a given list of criteria.

Methods


o ListWires
public virtual HRESULT ListWires( const CATListValCATUnicodeString* iListOfSystems,
const CATListValCATUnicodeString* iListOfCriteria,
CATLONG32& oWiresCount,
CATEwrWire*& oListOfWires) = 0
Retrieves the list of wires 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 wires for a configuration (may be NULL).
oWiresCount
The number of wires
oListOfWires
The list of wires
Returns:
An HRESULT value.
Legal values:
S_OK
The wires have been retrieved.
E_FAIL
Error while retrieving the wires.

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

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