  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The UnicodeToASCII function takes an 16-bit wstring in Unicode and converts it to ASCII.
Syntax/Parameters
Syntax
string = UnicodeToASCII ( wstring data, [handle log] );
Parameters
data
A wstring containing Unicode text to convert.
log
An optional handle for a Log Object to place information about translation errors. If the value is set to NULL_HANDLE, the script default log is used. If not provided, information is not logged by errors and warnings are counted.
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.
If successful, the last error value will contain a count of warnings and errors for characters that could not be reasonably translated.
Remarks
The function moves through the source data and converts Unicode characters to ASCII character positions while converting each 16-bit word to a 7-bit byte. Unicode shares the ASCII characters, Characters that can be converted to ASCII are converted the others are set as reasonable facsimile or as an error character Ctrl+? (0x1F). When characters cannot be converted, an error condition is set and the number of failed conversion in the low word of the error code.
Use of the Ctrl+? (0x1F) character allows the caller to find bad characters without the ambiguity of a simple question mark. If desired, the character can be replaced with the ReplaceInString function to turn them into a ‘?’ or some other character.
Related Functions
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 >> |
© 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.