GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

EncodeString Function

Overview

The EncodeString function encodes a source string, Data or Pool Object and returns an encoded string.

Syntax/Parameters

Syntax

string = EncodeString ( string source | handle source, [dword mode], [ind pad] );

Parameters

source

A string or handle containing the data to be encoded. The handle can specify a Data Object or Pool Object. See Remarks for details.

mode

An optional dword specifying operating mode. See Remarks for details. The mode can be ENCODE_BASE32 or ENCODE_BASE64. The default is ENCODE_BASE64.

pad

An optional int containing a padding value to lead each line. The default value is zero. Note that is is not the trailing pad character for Base64.

Return Value

Returns a string containing the encoded data or empty on failure. Use the GetLastError and GetLastErrorMessage to retrieve a formatted error code and message.

Remarks

While EncodeString is meant to process a number of formats, it presently supports Base64.

For Base64, the mode has the following options:

ENCODE_NO_LINE_ENDINGS         Remove Line Endings (solid block)

ENCODE_ENCODE_LINE_ENDINGS     Encode Line Endings (\r)

When encode linings is used, the return token \r must be manually removed or changed to a return code before decoding. Not all decoders accept a solid block of Base64.

Base32 encoding is based on RFC 4648. Base32 encodes to a direct string without formatting.

Related Functions

BufferToFile — Writes a buffer (variable) to a file. 

DecodeFile — Decodes a file (Base64 or uuencode) from source to destination with optional mode.

DecodeString — Decodes a string (Base64/32) from with optional mode.

DecodeURI — Decodes a complete URL or part of a URI.

EncodeFile — Encodes a file (Base64 or uuencode) from source to destination with optional mode and padding.

EncodeString — Encodes a string (Base64) from with optional mode and padding.

EncodeURIComponent — Encodes URI components (URN sections).

FileToBuffer — Reads the content of a file into a buffer variable.

RunLengthEncode — Encodes a buffer of data using Run Length Encoding (RLE).

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/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.