  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The SetFilePosition function moves the current position to the start of a Basic File Object or an optionally specified position.
Syntax/Parameters
Syntax
int = SetFilePosition ( handle hBasicFile, [qword position ] );
Parameters
hBasicFile
A handle to a Basic File Object.
position
An optional qword containing a position from which the next read or write will apply. If omitted, the value will be zero.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information.
Remarks
The SetFilePosition function does not return an error if the position parameter sets the file pointer beyond the end of the file. This enlarges the file, however, the size of the file does not increase until the TruncateFilePosition, WriteBlock or WriteLine functions are called. A write operation increases the size of the file to the position specified plus the size of the buffer written, which results in the intervening bytes being uninitialized.
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.