All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMSTEPExchanges Interface ENOVIExReportLogFormat

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

Usage: you can freely reimplement this interface.


interface ENOVIExReportLogFormat

Description of the ENOVIExReportLogFormat Interface.
Role: This interface allows to manage the Output format of the report * log generated by Import/Export tools. The content of the report log is still temporarly stored in a model based on VPMExMergerReport format. Thanks to this interface, this content may be formatted on a required format (Text, Html, Xml, ...)


Method Index


o Convert(CATIContainer_var&,char*&,int&)
Starts converting operations.
o SaveContainerInFile(CATIContainer_var&,CATUnicodeString&,CATBoolean)
Generates and saves the Report Log.
o SaveInFile(char*&,CATUnicodeString&)
Saves Ouput Stream in a file.

Methods


o Convert
public virtual HRESULT Convert( const CATIContainer_var& iReportContainer,
const char*& oStream,
int& oStreamLength)= 0
Starts converting operations.
Role: Generate the Report Log on the expected format from the VPMExReportManager model (it contains information for the log).
Parameters:
iReportContainer
CATIContainer that contains the information for the report log.
oStream
Char that contains the information for the report log with the expected format.
oStreamLength
Length of the Output stream oStream.
Returns:
Returns S_OK if the Stream oStream is correctly generated else returns E_FAIL
o SaveContainerInFile
public virtual HRESULT SaveContainerInFile( const CATIContainer_var& iReportContainer,
const CATUnicodeString& iFilePath,
CATBoolean iFileNew=CATTrue) = 0
Generates and saves the Report Log.
Role: Generate the Report Log on the expected format from the VPMExReportManager model and save it into a file.
Parameters:
iReportContainer
CATIContainer that contains the information for the report log.
iFilePath
The file path where to save the log on disk.
iNewFile
Boolean that specifies if the file is new or if information is added to an existing file
Returns:
Returns S_OK if the file is correctly saved else returns E_FAIL
o SaveInFile
public virtual HRESULT SaveInFile( const char*& iStream,
const CATUnicodeString& iFilePath) = 0
Saves Ouput Stream in a file.
Role: Save the generated Stream (method Convert) in a file.
Parameters:
iStream
Char that contains the information for the report log with the expected format. iStream is the result of the method Convert.
iFilePath
The file path where to save the Output Stream on disk.
Returns:
Returns S_OK if the Stream iStream is correctly saved else returns E_FAIL

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

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