All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVDDManager Interface ENOVIDocumentFile

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

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


interface ENOVIDocumentFile

Interface for ENOVIDocumentFile.
Role: This interface provides methods on ENOVIDocumentFile object. It is implemented in ENOVDDManager/VX0DDUtil.m.


Method Index


o UpdateVaultInfo()
Updates vault info, such as FileSize/CreationDate/LastModifiedDate, from the linked Vault documment on this file.
o UpdateVaultInfo(ENOVIVaultDocument*&)
Updates vault info, such as FileSize/CreationDate/LastModifiedDate, from input Vault document on this file.
o get_Extension(CATUnicodeString&)
Retrieves the file name extension of this file.
o get_FormatFromFile(ENOVIIterationFormat_var&)
Retrieves the format which this file belongs to.
o get_MIMEType(CATUnicodeString&)
Retrieves format type of this file.
o get_Revision(CATIAVPMObjectVersion*&)
Retrieves the revision which this file belongs to.

Methods


o UpdateVaultInfo
public virtual HRESULT UpdateVaultInfo()=0
Updates vault info, such as FileSize/CreationDate/LastModifiedDate, from the linked Vault documment on this file.
Returns:
S_OK in case of success, E_FAIL in case of error. S_FALSE if linked Vault document is not set.
o UpdateVaultInfo
public virtual HRESULT UpdateVaultInfo(ENOVIVaultDocument*& iVaultDocument)=0
Updates vault info, such as FileSize/CreationDate/LastModifiedDate, from input Vault document on this file.
Parameters:
iVaultDocument
The input Vault document.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_Extension
public virtual HRESULT get_Extension(CATUnicodeString& oExtension)=0
Retrieves the file name extension of this file.
Parameters:
oExtension
The file name extension
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_FormatFromFile
public virtual HRESULT get_FormatFromFile(ENOVIIterationFormat_var& oDocFormat)=0
Retrieves the format which this file belongs to.
Parameters:
oDocFormat
The document format object
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_MIMEType
public virtual HRESULT get_MIMEType(CATUnicodeString& oMimeType)=0
Retrieves format type of this file.
Parameters:
oMimeType
The document format type
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_Revision
public virtual HRESULT get_Revision(CATIAVPMObjectVersion*& oDocRevision)=0
Retrieves the revision which this file belongs to.
Parameters:
oDocRevision
The document revision object
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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