  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The OutlineCreateObject function creates an outline object which can be loaded with data and subsequently queried for content.
Syntax/Parameters
Syntax
handle = OutlineCreateObject ( [string filename | handle hObject], int flags );
Parameters
filename
An optional string specifying a qualified HTML source file. Or,
hObject
An optional handle specifying an object to map the content. The parameter can be a Mapped Text, Edit, or an SGML Object. Both filename and hObject parameters items can be omitted.
flags
An optional int value specifying mapping flags. See Section 11.6 The HTML Outline Object at the beginning of this section for flags values. The default is flags to zero or none. If the filename or hObject parameter is not specified, this parameter is ignored.
Return Value
A handle value or NULL_HANDLE (0) on error. Use the GetLastError function to retrieve a formatted error code. Use the CloseHandle function to release the object.
Remarks
HTML Outline creates its own SGML parser based on the DTD specifications within the incoming file. Depending on the size of the incoming data, the function can take some time to map and return. Progress is not updated.
The flags are a bitwise combination specified at the start of this section and determine what is outlined.
If an object is specified, the embedded mapped text object is borrowed to perform the outline map. As such, if an SGML Object is supplied, operations within the Outline Object do not alter information within the SGML object. If the source object’s file content are altered, those alterations do not update the outline information. In such a case it is best to discard the Outline Object and create a new outline.
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.