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

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

UnicodeToUTF Function

Overview

The UnicodeToUTF function takes an 16-bit wstring in Unicode and converts it to Unicode Text Format (UTF).

Syntax/Parameters

Syntax

string = UnicodeToUTF ( wstring data );

Parameters

data

A wstring containing Unicode text to convert.

Return Value

Returns a string containing the converted string. Use the IsError, IsNotError and GetLastError functions to determine if an error occurred and to retrieve a formatted error code.

Remarks

The function moves through the source data and encodes 16-bit Unicode characters to 8-bit text.

Note that there is no way to explicitly tell an 8-bit string’s encoding. Further, if written to a file, a UTF header may need to be manually inserted, depending on the eventual use of the data. For example:

    string          src, dst;
    string          s1;
    wstring         w1;
    int             rc;

    src = "(insert source name)";
    dst = "(insert destination name)";

    w1 = FileToString(src);
    if (w1 == "") {
      MessageBox('x', "Error %08X loading source", GetLastError());
      exit;
      }

    s1 = UnicodeToUTF(w1);
    if (s1 == "") {
      MessageBox('x', "Error %08X converting", GetLastError());
      exit;
      }

    s1 = "\xEF\xBB\xBF" + s1;                       // Manually add header
    rc = StringToFile(s1, dst);
    if (IsError(rc)) {
      MessageBox('x', "Error %08X writing results", GetLastError());
      exit;
      }

 

Related Functions

AnsiToUnicode — Converts an ANSI string to Unicode.

EntitiesToUTF — Converts a string with character entities to a UTF-8 string.

UnicodeToAnsi — Converts a Unicode string to ANSI.

UnicodeToASCII — Converts a Unicode string to ASCII.

UTFToEntities — Converts a string containing UTF-8 encoding to SGML character entities.

UTFToUnicode — Converts Unicode Formatted Text string to Unicode.

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.