  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The UTFToEntities function takes a UTF encoded string and converts it into an ASCII string with SGML character entities.
Syntax/Parameters
Syntax
string = UTFToEntities ( string data, [boolean pcdata] );
Parameters
data
A string containing UTF text to convert.
pcdata
An optional boolean value specifying to treat the data as PCDATA, that is not to encode protected characters. The default is FALSE.
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
Characters are converted to SGML character entity values in the form of &#nnnn;, where nnn is the translated decimal code. Values over 0x7F are converted. If sequence is not in valid UTF syntax, each character is converted.
Note the protected characters &, < and > are also processed unless the pcdata parameter is TRUE.
If the resulting string is larger than 1,048,575, an overflow condition will be returned.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
Page revised 2024-10-21
| 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.