All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Interface CATIDocId

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

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


interface CATIDocId

Interface allowing access to a document's unique identification information.


Method Index


o GetDocEnvironment(CATIDocEnvironment**)
Retrieves the document's environment element.
o GetIdentifier(CATUnicodeString&)
Retrieves the document's identifier.
o GetType(CATUnicodeString&)
Retrieves the document's type.

Methods


o GetDocEnvironment
public virtual HRESULT GetDocEnvironment(CATIDocEnvironment** oDocEnvironment) = 0
Retrieves the document's environment element.
Parameters:
oDocEnvironment
The returned document environment element.
o GetIdentifier
public virtual HRESULT GetIdentifier(CATUnicodeString& oIdentifier) = 0
Retrieves the document's identifier. This is the storage path name of the document.
Parameters:
oIdentifier
The returned document identifier.
o GetType
public virtual HRESULT GetType(CATUnicodeString& oType) = 0
Retrieves the document's type. This is the document's suffix, such as CATPart, CATDraw, etc.
Parameters:
oType
The returned document type.

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

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