  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The SGMLGetEntryFlags function returns the parsing flags for a specified parameter entry within an SGML Object.
Syntax/Parameters
Syntax
dword = SGMLGetEntryFlags ( handle hSGML, int index );
Parameters
hSGML
A handle to an SGML Object.
index
An int specifying the zero-based index position of the entry.
Return Value
A dword containing the flags or a formatted error code on failure.
If the property name cannot be translated, the value 0x1002 will be ORed bitwise with the error code.
Remarks
Working directly with parameter entries is appropriate for certain operations. In most cases, accessing by parameter token or name is preferable. An element must be selected in the SGML Object to have any parameters loaded or modified using the SGMLNextElement, SGMLPreviousElement or SGMLSetParameter functions.
The parameter flags relay information regarding the parsing or state of particular attribute or property. Actions after an element has been loaded will also set or reset flags depending on the process. For example, normalizing HTML to CSS will set flags on HTML attributes that have been promoted to CSS properties.
The bitwise flags are as follows:
| Definition | Bitwise | Description | |||||
| General | |||||||
| SGML_PE_PARAMETER_OK_MASK | 0x003F | No Errors or Remove Mask (0 = OK) | |||||
| SGML_PE_ERROR | 0x0001 | Error in Entry (General) | |||||
| SGML_PE_OUT_OF_CONTEXT | 0x0002 | The Attribute not in DTD for Element | |||||
| SGML_PE_UNKNOWN_ATTRIBUTE | 0x0004 | The Attribute was not in the DTD | |||||
| SGML_PE_UNKNOWN_PROPERTY | 0x0008 | The CSS Properties is Unknown | |||||
| SGML_PE_DELETED | 0x0010 | This Item Has Been Deleted | |||||
| SGML_PE_RESERVED | 0x0020 | (Bit is Available as Error) | |||||
| CSS | |||||||
| SGML_PE_CSS_CONFLICT | 0x0040 | Attribute Conflict with CSS† | |||||
| SGML_PE_CSS_OVERRIDE | 0x0080 | Value Moved to CSS Property | |||||
| SGML_PE_CSS_IMPORTANT | 0x0100 | !Important Term Was Used | |||||
| Format | |||||||
| SGML_PE_PRECEED_BY_RETURN | 0x0200 | The Attribute was on a New Line | |||||
| SGML_PE_VALUE_QUOTED | 0x0400 | The Attribute/Value was Quotes (HTML) | |||||
| SGML_PE_NO_SPACE_ON_EMPTY_ELEMENT | 0x0800 | No Leading Space on Empty Element | |||||
| Control | |||||||
| SGML_PE_CSS_CONTROL_MASK | 0xF000 | CSS Control Mask | |||||
| SGML_PE_CSS_MARKED | 0x1000 | General Marking Flag† | |||||
| SGML_PE_CSS_DERIVED_FROM_SHORTHAND | 0x2000 | Value Came from CSS Shorthand | |||||
| SGML_PE_CSS_PROMOTED_FROM_MSO | 0x4000 | Was Promoted from MSO (no detail)† | |||||
| SGML_PE_CSS_CONFLICT_WITH_MSO | 0x8000 | Conflicted with MSO (no detail)† | |||||
The dagger (†) indicates that the flag will only be set if an additional processing action has been taken.
MSO (Microsoft Office) employs a series of CSS properties that can be promoted by certain operations to standard CSS properties.
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.