  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Fourteen — Project Functions (continued)
Overview
The ProjectClose function closes the currently open project.
Syntax/Parameters
Syntax
int = ProjectClose ( [boolean force] );
Parameters
force
An optional boolean value indicating whether to force the close of a currently open and modified project. TRUE forces a modified project to close.
Return Value
Returns an int as ERROR_NONE if the project was closed successfully or a formatted error code on failure. If force is FALSE, failure to close a modified project returns ERROR_CANCEL_AUTO. Use the GetLastError function to retrieve error information.
Remarks
Depending on whether or not the force parameter is FALSE, the ProjectClose function may fail to close a modified project. This function does not query the user as to how to handle this situation and simply returns ERROR_CANCEL_AUTO. If a project is not open, the function will succeed without error or warning.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
| 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.