  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The SGMLGetItemPosition function returns the start and end file position of last parsed item.
Syntax/Parameters
Syntax
int[] = SGMLGetItemPosition ( handle hSGML );
Parameters
hSGML
A handle to an SGML object.
Return Value
Returns an int array containing the file positions or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
The positions are returned as:
| Key Name | Description | |||
| s_x | Zero based X starting position of item. | |||
| s_y | Zero based Y starting position of item. | |||
| e_x | Zero based X ending position of item. | |||
| e_y | Zero based Y ending position of item. |
Calling this function without first calling a function that engages a parse action results in the return of an undefined result. X positions are always a native file position.
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.