  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The SGMLSetCommentMode function sets the comment processing mode of the SGML parser.
Syntax/Parameters
Syntax
int = SGMLSetCommentMode ( handle hSGML, int mode );
Parameters
hSGML
A handle to an SGML Object.
mode
An int specifying the mode to employ.
Return Value
An int as ERROR_NONE (0) or a formatted error code.
Remarks
Comments can be treated by the parser as structured data. By default, when a parser is created by SGMLCreate, comments are simply collected as a string without processing. The allowable modes are as follows:
SPC_TEXT 0 Treat as Text
SPC_COLON_SINGLE 1 Colon Delimited (dog: legs)
SPC_COLON_MULTIPLE 2 Colon Multiple (dog: legs; cat: fur)
SPC_ATTRIBUTES 3 Treat as Element Attribute
For all modes except SPC_TEXT, the internal parameter array is loaded with the items. SPC_COLON_ modes expect the content to look like a CSS declaration as property: value pairs while the SPC_ATTRIBUTES mode expects the internal data to be formatted in attribute=value pairs.
Some function, particularly objects that deal with pseudo code fields, will set the parser to SPC_COLON_MULTIPLE mode.
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.