  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
GetMappedTextEncodingString Function
Overview
The GetMappedTextEncodingString function returns the encoding of a Mapped Text Object as a string.
Syntax/Parameters
Syntax
string = GetMappedTextEncodingString ( handle hMappedText );
Parameters
hMappedText
A handle to a valid Mapped Text or Edit Object.
Return Value
Returns a string specifying the encoding of the mapped text object or an empty string on failure. Use the GetLastError function retrieve error information.
Remarks
The possible return values are as follows:
| 'no encoding' | No encoding detected, ANSI |
| 'UNICODE' | UNICODE (Little Endian) |
| 'UNICODE (Big Endian)' | UNICODE (Big Endian) |
| 'UNICODE (UTF-8)' | UTF-8 |
Note that UTF-8 will not have the MTE_UNICODE flag set since the characters are 8-bit. When a file is encoded as UTF-8, it is up to the script to read text and then decode it as required.
If the hMappedText parameter is invalid, the GetLastError function will return ERROR_INVALID_HANDLE.
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.