  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The EncodeFile function performs a level of encoding on a source file and saves the result to a destination file.
Syntax/Parameters
Syntax
int = EncodeFile ( string source, string destination, [int mode], [int pad] );
Parameters
source
A string specifying the source filename and path. This file can be a URL.
destination
A string containing the destination filename and path. The file will be overwritten without warning.
mode
An optional int containing a mode. Encode file only supports ENCODE_BASE64. This must be zero or ENCODE_BASE64 if pad is provided.
pad
An optional int specifying a pad value. Padding is inert but can help make the resulting output conform more closely with the coding containing the encoded data.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. The error can apply to either the source or the destination file as indicated by the ERROR_DT_SOURCE or ERROR_DT_DESTINATION flags, respectively, or to the actual encoding of the file.
Remarks
The function currently only supports Base64.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.