All Frameworks Class Hierarchy This Framework Previous Next Indexes
ObjectModelerBase Class CATOmbDocIdFinder
CATOmbDocIdFinder
Usage: you must use this class as is. You should never derive it.
public class CATOmbDocIdFinder
Class to retrieve a CATIDocId pointer from a document's identifier.
Role:This class enables you to retrieve a CATIDocId interface pointer from a document identifier streamed as a CATUnicodeString.
Method Index
- o
RecoverDocId(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIDocId**)
- Retrieves a CATIDocId pointer from a document's identifier.
Methods
o RecoverDocId
-
Retrieves a CATIDocId pointer from a document's identifier.
- Parameters:
-
- iDocEnvironmentIdentifier
- It is the identifier of the environment. For a "File" environment, the value
of this string is "File".
- iDocumentIdentifier
- It is the document's identifier under CATUnicodeString format. For the
"File" environment, the string is the path of the document.
You can retrieve this information using the
CATIDocId.GetIdentifier method. The
CATIDocId interface pointer is first retrieved using the
CATDocument.GetDocId method.
- iDocType
- It is the extension of the document. CATPart, CATProduct,...
- oDocId
- The unique document's identifier.
This object is included in the file: CATOmbDocIdFinder.h
If needed, your Imakefile.mk should include the module: CATObjectModelerBase