InterOp:Connect/Classes/SPAIConverter

From DocR18

Jump to: navigation, search

The SPAIConverter class manages the conversion process of a file from one format to another. It represents the primary interface for file translation. The SPAIConverter class also allows for translation control with options, logging, and progress report methods.

Include File

This class is declared in SPAIConverter.h.

Members

SPAIConverter()

Default constructor.

virtual ~SPAIConverter()

Virtual destructor.

SPAIResult SetOptions(const SPAIOptions& iOptions)

This method sets the translation options using the parameter of type, SPAIOptions. This method returns the status through an object of SPAIResult class.

SPAIResult Convert(const SPAIDocument& iSourceDocument, const SPAIDocument& iTargetDocument)

This method translates the source document, specified by iSourceDocument, to the destination, specified by iTargetDocument. The translated document is not saved automatically. The translation status is returned through an object of the SPAIResult class.

SPAIResult StartLog(const SPAIFile& iLogFile)

This method enables writing the log information for the translation process to a log file. The parameter, iLogFile, specifies the name of the log file.

SPAIResult StopLog(const SPAIFile& iLogFile)

This method disables writing the log information for the translation process.

SPAIResultSPAIResult SetProgressCallback(const SPAIProgressCallback iCallbackFunction)

This method sets a callback function that enables the embedding application to monitor the translation progress.

Personal tools
new releases