  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The SGMLValueToString function converts a structured parameter value (pvalue) to a string within the context of the current element.
Syntax/Parameters
Syntax
string = SGMLValueToString ( dword pvalue, [handle hSGML], [dword token] )
Parameters
pvalue
A dword specifying a structured parameter value (can also be defined as a PVALUE).
hSGML
An optional handle to an SGML object. If omitted, only fixed values may be processed.
token
A dword specifying a reference HTML attribute or CSS property token. This value is required if the structure is PT_KEYWORD type.
Return Value
A string containing the translated value or an empty string on error. The value can be empty if the pvalue specifies a string which happens to be empty. Use the GetLastError and IsError functions to differentiate between an error and an empty string.
Remarks
This function operates in two modes: as a simple structured parameter value conversion and as a heap based conversion. The former does not require an SGML object. For any operation that requires a heap (strings, errors, arrays), an SGML object must be supplied with a value heap area.
Any items marked as PT_KEYWORD must have a token context.
Measurements are generally in 100ths of units except for inches which are 10000ths.
Errors processed by this function will return a string with “(error-description)”. The description may not be present if the underlying error is not set.
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.