All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

InteractiveInterfaces Interface CATIIniLayer

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

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


interface CATIIniLayer

Interface to a layer.
Role: This interface gives a read access to a layer.
This interface is implemented on all the layers. The CATIIniDocumentLayersDefinition interface returns pointers to CATIIniLayer and you can use CATIIniLayer methods to retrieve the name or the comment of the corresponding layer.


Method Index


o GetName(CATUnicodeString&)
Retrieves the layer name.
o GetNumber(int&)
Retrieves the layer number.

Methods


o GetName
public virtual HRESULT GetName(CATUnicodeString& oLayerName) = 0
Retrieves the layer name.
Returns:
The layer name.
Returns:

Legal values:
  • S_OK if the read access succeeded
  • E_FAIL if the interface pointer is wrong
o GetNumber
public virtual HRESULT GetNumber(int& oLayerNumber) = 0
Retrieves the layer number.
Returns:
The layer number.
Returns:

Legal values:
  • S_OK if the read access succeeded
  • E_FAIL if the interface pointer is wrong

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

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