  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The GetFilePosition function returns the read/write position for a Basic File Object.
Syntax/Parameters
Syntax
qword = GetFilePosition ( handle hBasicFile );
Parameters
hBasicFile
A handle to a Basic File Object.
Return Value
Returns a qword value indicating the current position for reading and writing to the file or -1 on failure. If hBasicFile is invalid, the function will return ERROR_INVALID_HANDLE. Use the GetLastError function to retrieve error information.
Remarks
The GetFilePosition function returns the byte position within the Basic File Object. For example, if 306 bytes have been read from a Basic File Object before this function is called, the read/write position within the Basic File Object will be 306 and the GetFilePosition function will return 306. To return a row/column position, a Mapped Text Object must be used in conjunction with the [GetFileXYPosition] function.
Related Functions
GetFileXYPosition
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.