All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Interface CATIDocEnvironment

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

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


interface CATIDocEnvironment

Interface allowing access to a document's identification and descriptor elements.


Method Index


o GetDocDisplayName(CATIDocId*,CATUnicodeString&)
Retrieves the display name of the document.
o GetName(CATUnicodeString&)
Retrieves the NLS name.

Methods


o GetDocDisplayName
public virtual HRESULT GetDocDisplayName(CATIDocId* iDocId,
CATUnicodeString& oDocDisplayName) = 0
Retrieves the display name of the document.
Parameters:
iDocId
The object which identifies the document in this environment.
oDocDisplayName
The name of the document to display, for example in the document's window.
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName) = 0
Retrieves the NLS name.

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

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