All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface ENOVIDocumentable

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

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


interface ENOVIDocumentable

Interface to manage associated documents.


Method Index


o DetachDocument(CATIAVPMDocumentVersion*,CATUnicodeString&,CATUnicodeString&)
Detaches an associated document.
o get_Documents(CATListOfCATIAVPMDocumentVersion&,CATUnicodeString&,CATICfgFilter*,CATUnicodeString&,CATUnicodeString&)
Retrieves the Documents that matches the criteria of specified DocumentType, Config Filter and Domain Name.
o put_Document(CATIAVPMDocumentVersion*,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Associate a new Document.

Methods


o DetachDocument
public virtual HRESULT DetachDocument( const CATIAVPMDocumentVersion* iDocument,
const CATUnicodeString& iDocumentType="",
const CATUnicodeString& iDomainName="")=0
Detaches an associated document.
Parameters:
iDocumentType
The document to detach.
iDocumentType
The document type.
Legal Values: The default value for the Document Type is set to "VPMTPDocument".
iDomainName
The Domain Name.
Legal Values: The default value for the Domain Name is set to "TEMPLAT".
Returns:
  • S_OK DetachDocument succeeded.
  • S_FALSE iDocument is not associated to this.
  • E_FAIL DetachDocument failed.
o get_Documents
public virtual HRESULT get_Documents(CATListOfCATIAVPMDocumentVersion& oDocument,
const CATUnicodeString& iDocumentType="",
const CATICfgFilter* icfgFilter=NULL,
const CATUnicodeString& iDomainName="",
const CATUnicodeString& iRole="ENO_UNVAL")=0
Retrieves the Documents that matches the criteria of specified DocumentType, Config Filter and Domain Name.
Parameters:
oDocument
The CATListOfCATIAVPMDocumentVersion.
iDocumentType
The Document Type.
Legal Values: The default value for the Document Type is set to "".
icfgFilter
The Config Filter.
Legal Values: The default value for the CATICfgFilter is set to NULL.
iDomainName
The Domain Name.
Legal Values: The default value for the Domain Name is set to "".
iRole
The Role Name.
Legal Values: The default value for the Role Name is set to "ENO_UNVAL" (i.e. we don't filter on this attribute). if iRole is "ENO_NOPRIMSEC", return documents neither Primary, nor Secondary.
o put_Document
public virtual HRESULT put_Document( const CATIAVPMDocumentVersion* iDocument,
const CATUnicodeString& iDocumentType="",
const CATUnicodeString& iDomainName="",
const CATUnicodeString& iRole="ENO_UNVAL")=0
Associate a new Document.
Parameters:
iDocument
The CATIAVPMDocumentVersion object.
iDocumentType
The Document Type.
Legal Values: The default value for the Document Type is set to "".
iDomainName
The Domain Name.
Legal Values: The default value for the Domain Name is set to "".
iRole
The Role Name.
Legal Values: The default value for the Role Name is set to "ENO_UNVAL" (i.e. we don't valuate this attribute).
Returns:
  • S_OK put_Document succeeded.
  • S_FALSE iDocument is already associated to this.
  • E_FAIL put_Document failed.

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

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