Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter FourteenProject Functions (continued)

ProjectClose Function

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