All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Interface CATIDocDescriptor

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

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


interface CATIDocDescriptor

Interface allowing access to a document and to its identification information.


Method Index


o GetDocEnvironment(CATIDocEnvironment**)
Retrieves the document environment.
o GetDocId(CATIDocId**)
Retrieves the document's unique identification information.
o GetDocType(CATUnicodeString&)
Retrieves the document type.
o GetDocument(CATDocument**)
Retrieves the document if it is already loaded in the session.

Methods


o GetDocEnvironment
public virtual HRESULT GetDocEnvironment(CATIDocEnvironment** oDocEnvironment) = 0
Retrieves the document environment.
Parameters:
oDocEnvironment
A pointer to the document environment
Returns:
S_OK if the document environment is successfully retrieved, or E_FAIL otherwise
o GetDocId
public virtual HRESULT GetDocId(CATIDocId** oDocId) = 0
Retrieves the document's unique identification information.
Parameters:
oDocId
A pointer to the retrieved document unique identification information
Returns:
S_OK if the document unique identification information is successfully retrieved, or E_FAIL otherwise
o GetDocType
public virtual HRESULT GetDocType(CATUnicodeString& oDocType) = 0
Retrieves the document type.
This is the document late type, also used as suffix, such as CATPart, CATProduct.
Parameters:
oDocType
The retrieved document type
Returns:
S_OK if the document type is successfully retrieved, or E_FAIL otherwise
o GetDocument
public virtual HRESULT GetDocument(CATDocument** oDocument) = 0
Retrieves the document if it is already loaded in the session.
Note: If the document isn't loaded in the session, this method should not load it.
Parameters:
oDocument
A pointer to the retrieved document
Returns:
S_OK if the document is successfully retrieved, or E_FAIL otherwise

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

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