  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The CloseFile function closes a file handle, performing the necessary clean-up and releasing the file for use by other processes.
Syntax/Parameters
Syntax
int = CloseFile ( handle hFile );
Parameters
hFile
A valid handle to a Basic File Object.
Return Value
Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError function to retrieve error information. Error codes match Windows system error codes (for a list, see the Appendix or MSDN).
Remarks
The CloseFile and CloseHandle functions are essentially the same. Each takes an open handle and performs the necessary cleanup to ‘close’ a handle. In the case of a file, the file is released and available for use by other processes, users or elsewhere within the program.
If an object is opened in a function as a local variable, it will automatically be closed on function return. The script automatically closes all open objects on exit.
Closing a handle will not save the state of the object or the data. Any unpreserved data will be lost without warning.
Related Functions
| 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.