All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface ENOVIAVaultAndDocFile

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

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


interface ENOVIAVaultAndDocFile

Class to manage associations with Files in the Vault.
Role: This interface allows to manage attached files

See also:
ENOVIVaultDocument


Method Index


o AggregateData(CATUnicodeString&,CATUnicodeString&,ENOVIVaultDocument*&)
creates a Vault document and puts it into the Vault
Returns E_FAIL if the Vault document was already created.
o AttachVaultDocument(ENOVIVaultDocument*)
associates current object with a Vault document.
o DeleteData()
delete the Vault document attached to the current object.
o IsDocumented()
check if there is a vault item attached to the current object.
o NotifyModifications()
allows to validate modifications done on the attached vault document
o get_Data(ENOVIVaultDocument*&)
get the Document File from the Vault.
o get_FileName(CATUnicodeString&)
get name of the attached File stored in the vault .
o get_Type(CATUnicodeString&)
get the type of the attached file, i.
o get_VaultName(CATUnicodeString&)
get the Vault name where the attached file is stored.
o put_VaultName(CATUnicodeString&)
sets the name of the Vault where the vault documents will be stored for the current object

Methods


o AggregateData
public virtual HRESULT __stdcall AggregateData( const CATUnicodeString& iFullPathName,
const CATUnicodeString& iType,
ENOVIVaultDocument*& oData)=0
creates a Vault document and puts it into the Vault
Returns E_FAIL if the Vault document was already created.
Parameters:
iFullPathName
: the full path file name.
iType
: the type of the file (CATPart,CATDrawing,...)
oData
: the created Vault document
o AttachVaultDocument
public virtual HRESULT __stdcall AttachVaultDocument(ENOVIVaultDocument* iVaultDocument)=0
associates current object with a Vault document.
Parameters:
iVaultDocument
the Vault entity which will be attached to current instance
o DeleteData
public virtual HRESULT __stdcall DeleteData()=0
delete the Vault document attached to the current object.
o IsDocumented
public virtual HRESULT __stdcall IsDocumented()=0
check if there is a vault item attached to the current object.
returns :
o NotifyModifications
public virtual HRESULT __stdcall NotifyModifications()=0
allows to validate modifications done on the attached vault document
o get_Data
public virtual HRESULT __stdcall get_Data(ENOVIVaultDocument*& oData)=0
get the Document File from the Vault. returns E_FAIL if no vault document is attached to the current object.x
Parameters:
oData
: the VaultDocument extracted from the Vault.
o get_FileName
public virtual HRESULT __stdcall get_FileName(CATUnicodeString& oFileName)=0
get name of the attached File stored in the vault .
Parameters:
oFileName
the name of the attached File
o get_Type
public virtual HRESULT __stdcall get_Type(CATUnicodeString& oType)=0
get the type of the attached file, i.e. the input type of the AggregateData method.
Parameters:
oType
the type of the attached file.
o get_VaultName
public virtual HRESULT __stdcall get_VaultName(CATUnicodeString& oVaultName)=0
get the Vault name where the attached file is stored.
Parameters:
VaultName
o put_VaultName
public virtual HRESULT __stdcall put_VaultName( const CATUnicodeString& iVaultName)=0
sets the name of the Vault where the vault documents will be stored for the current object
Parameters:
iVaultName
the Vault Name to be set.

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

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