GoFiler Legato Script Reference   Legato v 1.4j Application v 5.22b

Table of Contents	< < Previous	Next >>

 

Chapter Twenty-two — Conversion Functions (continued)

ConvertFile Function

Overview

The ConvertFile function performs a format translation of one file format to another. The function automatically detects the file types based on file extensions.

Use of the conversion features in no way abrogates the per workstation licensing requirements of application or its components. Use of the conversion SDK functions serving commercial production services, web services or large scale filing is prohibited under the standard license agreement unless covered by a separate and specific license agreement.

Syntax/Parameters

Syntax

int = ConvertFile ( string source, string destination,
               [handle hLog], [string options] );

Parameters

source

A string containing the source file to convert. The filename must have a supported extension and contain supported data.

destination

A string containing the destination file to write the results. The filename must have a supported extension and contain supported data. If a file exists with the same name, it is automatically overwritten.

hLog

An optional log object which will receive the log from the import. If a log is not specified, the default log will receive the information.

options

An optional string that specifies a series of property: value; parameters to override the application’s current conversion settings. When the See Conversion Options and Parameters at the beginning of this section.

Return Value

An int as ERROR_NONE (0) or a formatted error code on failure.

Remarks

Since converting may require certain components such Microsoft Office, programmers must be sure to setup the system and user account to allow access to office OLE features (simply installing the applications and running them once is enough to initialize Word and Excel).

By default, the function will use the conversion settings of the application. To control this, set options and use the “Defaults: True” option to reset all the conversion parameters

The ConvertFile function options are limited by the underlying application. If the application does not support the conversion, an error will be returned.

Related Functions

GetFileTypeCode — Gets file type by file content or extension and return type as code dword.

GetFileTypeString — Gets file type by file content or extension and return type as string.

LogAppendLog — Appends the contents of a specified log to another specified log or the default log.

LogDisplay — Displays the specified log as a tab in the Information View window.

LogExport — Exports a specified log to a file as XML, HTML or other formats.

LogImport — Imports a log file into a Log Object.

LogIndent — Indents log messages for subsequent messages.

LogOutdent — Outdents log messages for subsequent messages.

RunMenuFunction — Runs the specified menu function as if it is being run from the ribbon or menu. Dialog and message boxes may appear and suspend the script.

TranslateSetPostProcessHook — Sets a post process translate hook.

Platform Support

Go13, GoFiler Complete, GoFiler Corporate, GoFiler, GoXBRL

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 04/22/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.