  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
ValueToCharacterEntity Function
Overview
The ValueToCharacterEntity function converts an HTML/XML character value to a character entity string.
Syntax/Parameters
Syntax
string = ValueToCharacterEntity ( dword value, [dword flags] );
Parameters
value
A dword specifying the character to convert.
flags
An optional dword specifying bitwise options for the conversion. The default value is 0x00000000, which is appropriate for HTML 5.
Return Value
Returns a string as the entity for the character value or empty on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
Characters are converted to an entity name if possible, or, failing that, a numeric position as decimal or hexadecimal. The flag options are as follows:
| SDK Define | Bitwise | Comment | ||||
| CE_XML_ONLY | 0x00000001 | XML Characters Only — Only & < > " and ' are converted to named entities. | ||||
| CE_HTML_4_ONLY | 0x00000002 | HTML 4 Characters Only — Characters not named in this list are converted to numeric positions. | ||||
| CE_HEX_CHARACTERS | 0x00000010 | Create Hex Entity Values — Use hexadecimal as opposed to decimal values. |
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.