  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetLineCount function will return the total number of lines in a Mapped Text Object.
Syntax/Parameters
Syntax
int = GetLineCount ( handle hObject );
Parameters
hObject
A handle to a valid Mapped Text or Edit Object.
Return Value
Returns an int containing the total number of lines or -1 on failure. Use the GetLastError function to retrieve error information.
Remarks
The line count of a Mapped Text Object is dynamic depending on actions performed. Therefore, if lines are inserted or deleted or if a segment is written, this value will change. Since a Mapped Text Object can be associated with a window or other more complex objects, the line count may change outside of the actions of the script. Use the GetLineCount function to return the current value.
In a Mapped Text or Edit Object, there is always a “line”; therefore, an empty file/object will always contain 1 line.
If the hObject parameter is invalid, the GetLastError function will return ERROR_FILE | ERROR_INVALID_HANDLE.
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.