GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Six — File Functions (continued)

FileToString Function

Overview

The FileToString function loads the contents of a file into a string or a wstring.

Syntax/Parameters

Syntax

string  = FileToString ( string name );

wstring = FileToString ( string name );

Parameters

name

A string containing a qualified filename and path. This parameter supports UTF encoding for filenames with Unicode characters.

Return Value

Returns a string or a wstring containing the entire contents of the file or an empty string on failure. Use the GetLastError function to retrieve error information. The return type depends on whether the file has a Unicode header.

Remarks

The file is opened with read and write share options. Note that the contents of the file are not checked for binary data. The first /0 byte in the file will terminate the string.

After the file is loaded, the first two bytes are examined for a Unicode header. Only ‘little endian’ Unicode loading is supported; all others are treated as 8-bit data. If a Unicode file is loaded and set into an 8-bit string type, the string will be down converted, which may result in the loss of data.

Related Functions

AnsiToUnicode — Converts an ANSI string to Unicode.

ExplodeString — Explodes a string line-by-line or by a specified delimiter into array entries.

ImplodeArray — Implodes string array entries (list) into a composite string with optional glue string.

OpenFile — Opens the specified file as a Basic File Object.

ReadBlock — Reads a block of data directly to a variable from the current position of a Basic File Object.

ReadLine — Reads the next line of data from a Basic File or Pool Object, or, reads a specified line from a Mapped Text or Edit Object.

StringToFile — Writes a string to a specified file.

UnicodeToAnsi — Converts a Unicode string to ANSI.

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-12-13

 

Table of Contents	< < Previous	Next >>

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