  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetCaretXPosition function returns the X position of the caret as either a native or a realized position.
Syntax/Parameters
Syntax
int = GetCaretXPosition ( handle hObject, [boolean mode] );
Parameters
hObject
A handle to an Edit Object or an Edit View.
mode
An optional boolean containing a flag that requests the returned value be realized rather than native. By default, the returned value is native. Set the value to TRUE to retrieve the realized position.
Return Value
Returns an int containing the zero-based position of the caret or -1 on failure. Use the GetLastError function to retrieve error information.
Remarks
Not all windows and edit objects support caret positions. If the hEditObject parameter contains an invalid handle, the GetLastError function will return 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.